GNU bug report logs - #35228
26.1; Please consider adding a doc string for `extended-command-history'

Previous Next

Full log

Message #11 received at 35228 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: "Basil L. Contovounesios" <contovob <at> tcd.ie>
Cc: 35228 <at> debbugs.gnu.org
Subject: RE: bug#35228: 26.1; Please consider adding a doc string for
 `extended-command-history'
Date: Thu, 11 Apr 2019 08:43:58 -0700 (PDT)

> 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.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.