unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 18024@debbugs.gnu.org
Subject: bug#18024: 24.4.50; doc of `y-or-n-p' misses the main functionality: what it returns
Date: Tue, 15 Jul 2014 08:23:54 -0700 (PDT)	[thread overview]
Message-ID: <11537e47-82da-4913-9f97-8afb105bdada@default> (raw)

1. `y-or-n-p' is a *predicate*.  This is missing from the doc string,
because it says nothing about what the function returns if the user
answers `n' instead of `y'.  The doc string *must* tell users that `n'
means return nil.

2. The Elisp manual does not have that failing.  However, to be clear,
both it and the doc string should specify that *whatever* way the user
answers in the affirmative means return `t', and *whatever* s?he answers
in the negative means return `nil'.  Currently the manual specifies the
return value only for `y' and `n'.

In GNU Emacs 24.4.50.1 (i686-pc-mingw32)
 of 2014-06-28 on ODIEONE
Bzr revision: 117431 rgm@gnu.org-20140628015517-eku6hj8mpgcvfnso
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/Devel/emacs/snapshot/trunk
 --enable-checking=yes,glyphs 'CFLAGS=-O0 -g3'
 LDFLAGS=-Lc:/Devel/emacs/lib 'CPPFLAGS=-DGC_MCHECK=1
 -Ic:/Devel/emacs/include''





             reply	other threads:[~2014-07-15 15:23 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-07-15 15:23 Drew Adams [this message]
2014-07-15 19:36 ` bug#18024: 24.4.50; doc of `y-or-n-p' misses the main functionality: what it returns Glenn Morris
2014-07-15 21:34   ` Drew Adams
2016-04-29 22:03 ` Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=11537e47-82da-4913-9f97-8afb105bdada@default \
    --to=drew.adams@oracle.com \
    --cc=18024@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).