GNU bug report logs - #36989
26.2; Doc string of `y-or-n-p': say it returns nil if answer is not `y' or `DEL'

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 36989 in the body.
You can then email your comments to 36989 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: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.2; Doc string of `y-or-n-p': say it returns nil if answer is not
 `y' or `DEL'
Date: Fri, 9 Aug 2019 09:44:48 -0700 (PDT)

Subject line says it all.  The doc says only that it returns `t' if the
answer is `y'.  It should also say what it returns if the answer is no
(not `y' or `DEL').

(The Elisp manual is OK for this.)

In GNU Emacs 26.2 (build 1, x86_64-w64-mingw32)
 of 2019-04-13
Repository revision: fd1b34bfba8f3f6298df47c8e10b61530426f749
Windowing system distributor `Microsoft Corp.', version 10.0.17763
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''

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

From: Noam Postavsky <npostavs <at> gmail.com>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 36989 <at> debbugs.gnu.org
Subject: Re: bug#36989: 26.2;
 Doc string of `y-or-n-p': say it returns nil if answer is not `y' or
 `DEL'
Date: Fri, 09 Aug 2019 13:02:55 -0400

Drew Adams <drew.adams <at> oracle.com> writes:

> Subject line says it all.  The doc says only that it returns `t' if the
> answer is `y'.  It should also say what it returns if the answer is no
> (not `y' or `DEL').

Did you miss where it says:

    Return t if answer is "y" and nil if it is "n".
                                  ^^^^^^^^^^^^^^^^

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

From: Drew Adams <drew.adams <at> oracle.com>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 36989 <at> debbugs.gnu.org
Subject: RE: bug#36989: 26.2; Doc string of `y-or-n-p': say it returns nil if
 answer is not `y' or `DEL'
Date: Fri, 9 Aug 2019 10:20:37 -0700 (PDT)

> > Subject line says it all.  The doc says only that it returns `t' if
> > the answer is `y'.  It should also say what it returns if the answer
> > is no (not `y' or `DEL').
> 
> Did you miss where it says:
>     Return t if answer is "y" and nil if it is "n".
>                                   ^^^^^^^^^^^^^^^^

No, I didn't miss it, because it's not in the Emacs release
I reported on (the latest release, AFAIK): Emacs 26.2.

This is the full doc string (`C-h f'):

y-or-n-p is a compiled Lisp function in 'subr.el'.

(y-or-n-p PROMPT)

Ask user a "y or n" question.  Return t if answer is "y".
Takes one argument, which is the string to display to ask the question.
It should end in a space; 'y-or-n-p' adds '(y or n) ' to it.
No confirmation of answer is requested; a single character is enough.
Also accepts SPC to mean yes, or DEL to mean no.

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

From: Noam Postavsky <npostavs <at> gmail.com>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 36989 <at> debbugs.gnu.org
Subject: Re: bug#36989: 26.2;
 Doc string of `y-or-n-p': say it returns nil if answer is not `y' or
 `DEL'
Date: Fri, 09 Aug 2019 13:26:20 -0400

notfound 36989 26.2
found 36989 24.5
tags 36989 fixed
close 36989 25.1
quit

Drew Adams <drew.adams <at> oracle.com> writes:

>> Did you miss where it says:
>>     Return t if answer is "y" and nil if it is "n".
>>                                   ^^^^^^^^^^^^^^^^
>
> No, I didn't miss it, because it's not in the Emacs release
> I reported on (the latest release, AFAIK): Emacs 26.2.

I don't think you are looking at the docstring from Emacs 26.2.

https://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/subr.el?h=emacs-26.2#n2507

> Ask user a "y or n" question.  Return t if answer is "y".

That seems to be the docstring from 24.5.

https://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/subr.el?h=emacs-24.5#n2212

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

From: Drew Adams <drew.adams <at> oracle.com>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 36989 <at> debbugs.gnu.org
Subject: RE: bug#36989: 26.2; Doc string of `y-or-n-p': say it returns nil if
 answer is not `y' or `DEL'
Date: Fri, 9 Aug 2019 10:32:33 -0700 (PDT)

> I don't think you are looking at the docstring from Emacs 26.2.
> 
> > Ask user a "y or n" question.  Return t if answer is "y".
> 
> That seems to be the docstring from 24.5.

Very sorry.  My bad.  I am in 26.2, but that doc
string is from a redefinition I had of the function.

I'll close the bug, if you haven't already.
Sorry for wasting your time.  And thanks for
identifying the problem so quickly.

Previous Next

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