From: Drew Adams <drew.adams@oracle.com>
To: Lars Ingebrigtsen <larsi@gnus.org>, dalanicolai@gmail.com
Cc: 39887@debbugs.gnu.org
Subject: bug#39887: 26.3; Customize buffer does not show type expected
Date: Mon, 26 Oct 2020 15:51:13 -0700 (PDT) [thread overview]
Message-ID: <dc523c3a-1bcf-48cf-a2f0-951947bf9c47@default> (raw)
In-Reply-To: <877drcu09e.fsf@gnus.org>
> > The title already explains the bug. It would be great if the customize
> > buffer shows which type of variable is expected. Although the :type
> > keyword is included in the defcustom declaration, it is not shown in
> > the customization buffer which type is expected. If the wrong type is
> > filled in then the only error message given is "(mismatch)". Quite
> > some package writers do not - additionally - document their variables.
>
> The Customize buffer is supposed to be a user-friendly, easy interface
> to use, and displaying types like
>
> (alist :key-type symbol :value-type (choice symbol integer))
>
> which only would make sense to a programmer would be the wrong way to go
> here. The Customize interface already tries to guide the users as much
> as the type spec allows.
>
> I'm sure there are individual doc strings that could stand improving,
> though, in which case bug reports for those would be welcome. But I'm
> closing this bug report.
FWIW -
My comment went in the opposite direction:
+1. Great idea. The type declaration in the help
might also even be a link to the doc for :type.
I disagree that just because the Customize UI needs
be able to be amenable to non-lispers it should ONLY
have ever help for non-lispers. That doesn't follow.
Many (most?) Emacs users are also to some extent
lispers. And there's no reason that defcustoms are
necessarily limited to simple structures. Users who
who can understand complex Lisp structures can also
benefit from Customize, including the UI - especially
its type-checking. Customize is not only for
non-lispers.
When a defcustom type is simple, a non-lisper can
likely grok its spec in the help. Why do you suppose
that we put a command's signature in the `C-h f' help?
Why should a novice who uses `C-h k C-f' be presented
with `(forward-char &optional N)'? Why? Because some
Emacs users can benefit from that info.
And when a custome type is complex, a novice can just
ignore the type signature, and a knowledgeable lisper
can appreciate seeing it.
For the same reason that menu `State' has item `Show
Saved Lisp Expression', we should be able to show
users the :type expression.
How that's made available is a different (and open)
question. But whether users should be able to see
it within Customize should be answered with YES,
not NO (IMHO).
Option types can be a bear. The more help we offer
users, the better. This enhancement request was a
wonderful suggestion.
Yes, a user can use `C-h v' and move to the source
code to see the defcustom. But we can make it easier
to see the :type info - in context with the existing
value.
(Just one opinion.)
prev parent reply other threads:[~2020-10-26 22:51 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-03 17:06 bug#39887: 26.3; Customize buffer does not show type expected dalanicolai
2020-03-03 19:17 ` Drew Adams
2020-10-26 21:48 ` Lars Ingebrigtsen
2020-10-26 22:51 ` Drew Adams [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=dc523c3a-1bcf-48cf-a2f0-951947bf9c47@default \
--to=drew.adams@oracle.com \
--cc=39887@debbugs.gnu.org \
--cc=dalanicolai@gmail.com \
--cc=larsi@gnus.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).