all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: "Basil L. Contovounesios" <contovob@tcd.ie>
Cc: 35228@debbugs.gnu.org
Subject: bug#35228: 26.1; Please consider adding a doc string for `extended-command-history'
Date: Thu, 11 Apr 2019 08:43:58 -0700 (PDT)	[thread overview]
Message-ID: <db87c2d2-7b8a-41fe-9387-b07d64c4495b@default> (raw)
In-Reply-To: <87y34g4mzm.fsf@tcd.ie>

> How's the following?

OK.  But I think it should say that it's a history list
for functions, such as `read-from-minibuffer', that read
input in the minibuffer.

It should perhaps also say that the commands in question
are Emacs commands (as opposed to, say, shell commands or
whatever).  That's what "extended command" means, but it
wouldn't hurt to make this clear.

BTW, the Elisp manual says (only) this:

"A history list for arguments that are names of extended
commands."

That's in node `Minibuffer History', which covers what is
involved generally (so it should cover what "arguments"
means here).

However, I think it's wrong for the descriptions in that
node to speak of "arguments".  There is only ever one
HISTORY arg for any given minibuffer-reading function call.
What's said now is unclear, I think.  It would be good to
fix this language too.

Anyway, for this doc string how about something like this?

"Minibuffer history list for names of Emacs commands.
It is used by function `execute-extended-command'.
An Emacs command is anything that satisfies predicate `commandp'.
A minibuffer history list is used by functions such as
`read-from-minibuffer' that read input in the minibuffer.
The maximum effective length of such a list is controlled by the value
of variable `history-length'."

Do we need to mention `history-length' or to remind users
what a minibuffer history and an Emacs command are?  Perhaps
not, but it doesn't hurt.





  reply	other threads:[~2019-04-11 15:43 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-11 14:22 bug#35228: 26.1; Please consider adding a doc string for `extended-command-history' Drew Adams
2019-04-11 14:47 ` Basil L. Contovounesios
2019-04-11 15:43   ` Drew Adams [this message]
2020-08-22 14:45   ` Lars Ingebrigtsen

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=db87c2d2-7b8a-41fe-9387-b07d64c4495b@default \
    --to=drew.adams@oracle.com \
    --cc=35228@debbugs.gnu.org \
    --cc=contovob@tcd.ie \
    /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.