From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Fri, 29 Apr 2016 22:02:46 +0000 (+0200)
Subject: Minor doc clarification
X-Git-Tag: emacs-25.0.94~101
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=3852fd6e318b9860958c4a2b3c72d69e63ac2fbf;p=emacs.git

Minor doc clarification

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

(cherry picked from commit 5d1f3192d484edee92caa46cd7d699da3e920259)
---

diff --git a/lisp/subr.el b/lisp/subr.el
index ce49604f811..00a947397ae 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.