bug#47833: closed (27.2; Incomplete list of optional arguments in the docstring of `map-y-or-n-p')

[GNU bug Tracking System]

Your message dated Sat, 17 Apr 2021 11:26:24 +0300
with message-id <83im4lwc3z.fsf@gnu.org>
and subject line Re: bug#47833: 27.2; Incomplete list of optional arguments in 
the docstring of `map-y-or-n-p'
has caused the debbugs.gnu.org bug report #47833,
regarding 27.2; Incomplete list of optional arguments in the docstring of 
`map-y-or-n-p'
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs@gnu.org.)


-- 
47833: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=47833
GNU Bug Tracking System
Contact help-debbugs@gnu.org with problems
> --- Begin Message ---
>
>
>
> 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.
>
>
>
> --- End Message ---
> --- Begin Message ---
>
>
>
> 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@gnu.org>
> > Date: Fri, 16 Apr 2021 22:03:15 -0400
> > Cc: 47833@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.
>
>
> --- End Message ---