[Emacs-diffs] emacs-25 3852fd6 18/64: Minor doc clarification

[Lars Ingebrigtsen]

branch: emacs-25
commit 3852fd6e318b9860958c4a2b3c72d69e63ac2fbf
Author: Lars Ingebrigtsen <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>

    Minor doc clarification
    
    * lisp/subr.el (y-or-n-p): Document the return value from "n"
    (bug#18024).
    
    (cherry picked from commit 5d1f3192d484edee92caa46cd7d699da3e920259)
---
 lisp/subr.el |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lisp/subr.el b/lisp/subr.el
index ce49604..00a9473 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -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.