GNU bug report logs - #57937
29.0.50; Improve doc of (interactive current-prefix-arg ...)

Previous Next

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

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

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

From: Stefan Kangas <stefankangas <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 29.0.50; Improve doc of (interactive current-prefix-arg ...)
Date: Mon, 19 Sep 2022 12:12:52 -0400

Severity: wishlist

I think the explanation in (info "(elisp) Using Interactive") could
include a pointer to `current-prefix-arg', which AFAICT is only
documented much later in (info "(elisp) Prefix Command Arguments").

Perhaps something could be added also to
(info "(elisp) Interactive Examples")?

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: 57937 <at> debbugs.gnu.org
Subject: Re: bug#57937: 29.0.50;
 Improve doc of (interactive current-prefix-arg ...)
Date: Mon, 19 Sep 2022 19:33:57 +0300

> From: Stefan Kangas <stefankangas <at> gmail.com>
> Date: Mon, 19 Sep 2022 12:12:52 -0400
> 
> Severity: wishlist
> 
> I think the explanation in (info "(elisp) Using Interactive") could
> include a pointer to `current-prefix-arg', which AFAICT is only
> documented much later in (info "(elisp) Prefix Command Arguments").

There is already such a pointer there:

   There are three possibilities for the argument ARG-DESCRIPTOR:

   • It may be omitted or ‘nil’; then the command is called with no
     arguments.  This leads quickly to an error if the command requires
     one or more arguments.

   • It may be a string; its contents are a sequence of elements
     separated by newlines, one for each argument(1).  Each element
     consists of a code character (*note Interactive Codes::) optionally
     followed by a prompt (which some code characters use and some
     ignore).  Here is an example:

          (interactive "P\nbFrobnicate buffer: ")

     The code letter ‘P’ sets the command’s first argument to the raw
     command prefix (*note Prefix Command Arguments::).

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

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 57937 <at> debbugs.gnu.org
Subject: Re: bug#57937: 29.0.50; Improve doc of (interactive
 current-prefix-arg ...)
Date: Mon, 19 Sep 2022 15:35:12 -0400

Eli Zaretskii <eliz <at> gnu.org> writes:

> There is already such a pointer there:
>
>    There are three possibilities for the argument ARG-DESCRIPTOR:
>
>    • It may be omitted or ‘nil’; ...
>    • It may be a string; ...

I was thinking of this item:

   • It may be a Lisp expression that is not a string; ...

Here, I'd like to see an example like:

          (interactive current-prefix-arg)

and a brief pointer to `(elisp) Prefix Command Arguments'.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: 57937 <at> debbugs.gnu.org
Subject: Re: bug#57937: 29.0.50; Improve doc of (interactive
 current-prefix-arg ...)
Date: Tue, 20 Sep 2022 05:27:28 +0300

> From: Stefan Kangas <stefankangas <at> gmail.com>
> Date: Mon, 19 Sep 2022 15:35:12 -0400
> Cc: 57937 <at> debbugs.gnu.org
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> > There is already such a pointer there:
> >
> >    There are three possibilities for the argument ARG-DESCRIPTOR:
> >
> >    • It may be omitted or ‘nil’; ...
> >    • It may be a string; ...
> 
> I was thinking of this item:
> 
>    • It may be a Lisp expression that is not a string; ...
> 
> Here, I'd like to see an example like:
> 
>           (interactive current-prefix-arg)
> 
> and a brief pointer to `(elisp) Prefix Command Arguments'.

That comes _after_ the above-mention place, which already points to
that node, so what would be the point and the importance of repeating
the reference?  Using current-prefix-arg in a Lisp expression is not
different from using any other Lisp variable.

Previous Next

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