From: Drew Adams <drew.adams@oracle.com>
To: 35222@debbugs.gnu.org
Subject: bug#35222: 26.1; `read-command' documentation
Date: Wed, 10 Apr 2019 15:13:31 -0700 (PDT) [thread overview]
Message-ID: <54098355-6406-459c-9a3a-b7c5b4fe286b@default> (raw)
1. The doc string does not say what happens if DEFAULT is not provided
(so `nil') and the user enters empty input. And what happens is not
obvious. Please add that information to the doc string.
2. What does happen? Well, it's documented in (elisp) `High-Level
Completion'. But please add information to that Info node that helps
users understand a return value that is an empty-named interned
symbol, which has the print and read syntax `##'. It's pretty
unusual for the default behavior of a read command to return such an
odd beast. (The default behavior is the case when arg DEFAULT is
absent, hence `nil'.) And please provide a cross-reference to node
`Symbol Type', which explains this syntax.
User code that tests the result of `read-command' typically needs to
deal with the default DEFAULT case, hence with the possibility of the
function returning an uninterned symbol. Users need to be aware of
this possibility - it's a gotcha.
In GNU Emacs 26.1 (build 1, x86_64-w64-mingw32)
of 2018-05-30
Repository revision: 07f8f9bc5a51f5aa94eb099f3e15fbe0c20ea1ea
Windowing system distributor `Microsoft Corp.', version 10.0.17134
Configured using:
`configure --without-dbus --host=x86_64-w64-mingw32
--without-compress-install 'CFLAGS=-O2 -static -g3''
next reply other threads:[~2019-04-10 22:13 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-10 22:13 Drew Adams [this message]
2019-04-10 22:24 ` bug#35222: 26.1; `read-command' documentation Noam Postavsky
2019-04-10 23:32 ` Drew Adams
2019-04-11 18:55 ` Stefan Monnier
2019-04-12 0:11 ` Noam Postavsky
2019-04-11 14:02 ` Eli Zaretskii
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=54098355-6406-459c-9a3a-b7c5b4fe286b@default \
--to=drew.adams@oracle.com \
--cc=35222@debbugs.gnu.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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.