Minor doc clarification

* lisp/subr.el (y-or-n-p): Document the return value from "n"
(bug#18024).

diff --git a/lisp/subr.el b/lisp/subr.el
index 6cc2585122c198d4d49d2b1f711e4af81cbbd218..5477500b322079780f9ab59d4f52f1795e92ae48 100644 (file)
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -2478,7 +2478,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.