aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLars Ingebrigtsen2016-04-30 00:02:46 +0200
committerLars Ingebrigtsen2016-04-30 00:02:46 +0200
commit5d1f3192d484edee92caa46cd7d699da3e920259 (patch)
treec3a710e6ee1cf6e0e808ff27e6bf96ef5d24181f
parent27abf372836532c57be2e9e3ed23413729cc07fc (diff)
downloademacs-5d1f3192d484edee92caa46cd7d699da3e920259.tar.gz
emacs-5d1f3192d484edee92caa46cd7d699da3e920259.zip
Minor doc clarification
* lisp/subr.el (y-or-n-p): Document the return value from "n" (bug#18024).
-rw-r--r--lisp/subr.el3
1 files changed, 2 insertions, 1 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index 6cc2585122c..5477500b322 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -2478,7 +2478,8 @@ floating point support."
2478(declare-function x-popup-dialog "menu.c" (position contents &optional header)) 2478(declare-function x-popup-dialog "menu.c" (position contents &optional header))
2479 2479
2480(defun y-or-n-p (prompt) 2480(defun y-or-n-p (prompt)
2481 "Ask user a \"y or n\" question. Return t if answer is \"y\". 2481 "Ask user a \"y or n\" question.
2482Return t if answer is \"y\" and nil if it is \"n\".
2482PROMPT is the string to display to ask the question. It should 2483PROMPT is the string to display to ask the question. It should
2483end in a space; `y-or-n-p' adds \"(y or n) \" to it. 2484end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2484 2485