* bug#47833: 27.2; Incomplete list of optional arguments in the docstring of `map-y-or-n-p'
[not found] <m1czut6a60.fsf.ref@yahoo.es>
@ 2021-04-17 0:12 ` Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-04-17 2:03 ` Glenn Morris
0 siblings, 1 reply; 3+ messages in thread
From: Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2021-04-17 0:12 UTC (permalink / raw)
To: 47833
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.
^ permalink raw reply related [flat|nested] 3+ messages in thread* bug#47833: 27.2; Incomplete list of optional arguments in the docstring of `map-y-or-n-p'
2021-04-17 0:12 ` bug#47833: 27.2; Incomplete list of optional arguments in the docstring of `map-y-or-n-p' Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2021-04-17 2:03 ` Glenn Morris
2021-04-17 8:26 ` Eli Zaretskii
0 siblings, 1 reply; 3+ messages in thread
From: Glenn Morris @ 2021-04-17 2:03 UTC (permalink / raw)
To: Daniel Martín; +Cc: 47833
> -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.
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#47833: 27.2; Incomplete list of optional arguments in the docstring of `map-y-or-n-p'
2021-04-17 2:03 ` Glenn Morris
@ 2021-04-17 8:26 ` Eli Zaretskii
0 siblings, 0 replies; 3+ messages in thread
From: Eli Zaretskii @ 2021-04-17 8:26 UTC (permalink / raw)
To: Glenn Morris; +Cc: 47833-done, mardani29
> 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.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-04-17 8:26 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
[not found] <m1czut6a60.fsf.ref@yahoo.es>
2021-04-17 0:12 ` bug#47833: 27.2; Incomplete list of optional arguments in the docstring of `map-y-or-n-p' Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-04-17 2:03 ` Glenn Morris
2021-04-17 8:26 ` Eli Zaretskii
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).