]> code.delx.au - gnu-emacs/commitdiff
Minor doc clarification
authorLars Ingebrigtsen <larsi@gnus.org>
Fri, 29 Apr 2016 22:02:46 +0000 (00:02 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sun, 1 May 2016 17:27:10 +0000 (19:27 +0200)
* lisp/subr.el (y-or-n-p): Document the return value from "n"
(bug#18024).

(cherry picked from commit 5d1f3192d484edee92caa46cd7d699da3e920259)

lisp/subr.el

index ce49604f81148a64c00ec5ac284eee2935c2e7c8..00a947397ae78b2e31af2c0e889f92ee37ad01b7 100644 (file)
@@ -2312,7 +2312,8 @@ floating point support."
 (declare-function x-popup-dialog "menu.c" (position contents &optional header))
 
 (defun y-or-n-p (prompt)
-  "Ask user a \"y or n\" question.  Return t if answer is \"y\".
+  "Ask user a \"y or n\" question.
+Return t if answer is \"y\" and nil if it is \"n\".
 PROMPT 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.