GNU bug report logs - #47833
27.2; Incomplete list of optional arguments in the docstring of `map-y-or-n-p'

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 47833 in the body.
You can then email your comments to 47833 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: Daniel Martín <mardani29 <at> yahoo.es>
To: bug-gnu-emacs <at> gnu.org
Subject: 27.2; Incomplete list of optional arguments in the docstring of
 `map-y-or-n-p'
Date: Sat, 17 Apr 2021 02:12:55 +0200

The docstring of `map-y-or-n-p' misses an optional argument after "Takes
args...".  The following patch corrects the problem:

diff --git a/lisp/emacs-lisp/map-ynp.el b/lisp/emacs-lisp/map-ynp.el
index 86a0c76fd1..1b1943953c 100644
--- a/lisp/emacs-lisp/map-ynp.el
+++ b/lisp/emacs-lisp/map-ynp.el
@@ -39,7 +39,8 @@
 (defun map-y-or-n-p (prompter actor list &optional help action-alist
 			      no-cursor-in-echo-area)
   "Ask a series of boolean questions.
-Takes args PROMPTER ACTOR LIST, and optional args HELP and ACTION-ALIST.
+Takes args PROMPTER ACTOR LIST, and optional args HELP,
+ACTION-ALIST and NO-CURSOR-IN-ECHO-AREA.
 
 LIST is a list of objects, or a function of no arguments to return the next
 object or nil.

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

From: Glenn Morris <rgm <at> gnu.org>
To: Daniel Martín <mardani29 <at> yahoo.es>
Cc: 47833 <at> debbugs.gnu.org
Subject: Re: bug#47833: 27.2;
 Incomplete list of optional arguments in the docstring of
 `map-y-or-n-p'
Date: Fri, 16 Apr 2021 22:03:15 -0400

> -Takes args PROMPTER ACTOR LIST, and optional args HELP and ACTION-ALIST.
> +Takes args PROMPTER ACTOR LIST, and optional args HELP,
> +ACTION-ALIST and NO-CURSOR-IN-ECHO-AREA.

I suggest instead removing the sentence, which does nothing other than
list the arguments. describe-function displays the argument list anyway.

Message #13 received at 47833-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 47833-done <at> debbugs.gnu.org, mardani29 <at> yahoo.es
Subject: Re: bug#47833: 27.2;
 Incomplete list of optional arguments in the docstring of
 `map-y-or-n-p'
Date: Sat, 17 Apr 2021 11:26:24 +0300

> From: Glenn Morris <rgm <at> gnu.org>
> Date: Fri, 16 Apr 2021 22:03:15 -0400
> Cc: 47833 <at> debbugs.gnu.org
> 
> > -Takes args PROMPTER ACTOR LIST, and optional args HELP and ACTION-ALIST.
> > +Takes args PROMPTER ACTOR LIST, and optional args HELP,
> > +ACTION-ALIST and NO-CURSOR-IN-ECHO-AREA.
> 
> I suggest instead removing the sentence, which does nothing other than
> list the arguments. describe-function displays the argument list anyway.

Indeed.

The doc string of that function and its description in the ELisp
manual "needed work", so I fixed them on the emacs-27 branch, and I'm
marking this bug done.

Previous Next

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