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

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Thu, 11 Apr 2019 14:26:02 UTC

Severity: minor

Tags: wontfix

Found in version 26.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 35228 in the body.
You can then email your comments to 35228 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#35228; Package emacs. (Thu, 11 Apr 2019 14:26:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to Drew Adams <drew.adams <at> oracle.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Thu, 11 Apr 2019 14:26:02 GMT) Full text and rfc822 format available.

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

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.1; Please consider adding a doc string for
 `extended-command-history'
Date: Thu, 11 Apr 2019 07:22:56 -0700 (PDT)
Subject line says it all.

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




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#35228; Package emacs. (Thu, 11 Apr 2019 14:49:02 GMT) Full text and rfc822 format available.

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

From: "Basil L. Contovounesios" <contovob <at> tcd.ie>
To: Drew Adams <drew.adams <at> oracle.com>
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 15:47:57 +0100
[Message part 1 (text/plain, inline)]
How's the following?

[history.diff (text/x-diff, inline)]
diff --git a/lisp/simple.el b/lisp/simple.el
index 223e0116ae..5977f6c035 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -1713,7 +1713,11 @@ repeat-complex-command
 	(error "There are no previous complex commands to repeat")))))
 
 
-(defvar extended-command-history nil)
+(defvar extended-command-history nil
+  "History list for extended command name arguments.
+It is used by `execute-extended-command', and its maximum length
+is determined by the value of `history-length', which see.")
+
 (defvar execute-extended-command--last-typed nil)
 
 (defun read-extended-command ()
[Message part 3 (text/plain, inline)]
Thanks,

-- 
Basil

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#35228; Package emacs. (Thu, 11 Apr 2019 15:47:01 GMT) Full text and rfc822 format available.

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.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#35228; Package emacs. (Sat, 22 Aug 2020 14:46:02 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Basil L. Contovounesios" <contovob <at> tcd.ie>
Cc: Drew Adams <drew.adams <at> oracle.com>, 35228 <at> debbugs.gnu.org
Subject: Re: bug#35228: 26.1; Please consider adding a doc string for
 `extended-command-history'
Date: Sat, 22 Aug 2020 16:45:36 +0200
"Basil L. Contovounesios" <contovob <at> tcd.ie> writes:

> How's the following?

[...]

> -(defvar extended-command-history nil)
> +(defvar extended-command-history nil
> +  "History list for extended command name arguments.
> +It is used by `execute-extended-command', and its maximum length
> +is determined by the value of `history-length', which see.")

I kinda think this is unnecessary -- we have a gazillion history
variables in Emacs, and adding doc strings to them all is pretty
pointless -- it's self-evident what they're used for.

So I'm closing this bug report.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




Added tag(s) wontfix. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Sat, 22 Aug 2020 14:46:02 GMT) Full text and rfc822 format available.

bug closed, send any further explanations to 35228 <at> debbugs.gnu.org and Drew Adams <drew.adams <at> oracle.com> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Sat, 22 Aug 2020 14:46:02 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sun, 20 Sep 2020 11:24:05 GMT) Full text and rfc822 format available.

This bug report was last modified 3 years and 191 days ago.

Previous Next


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