From: Richard M. Stallman <rms@gnu.org>
Date: Sun, 4 Sep 2005 01:48:26 +0000 (+0000)
Subject: (Programming Tips): Add conventions for minibuffer questions and prompts.
X-Git-Tag: emacs-pretest-22.0.90~7261
X-Git-Url: https://code.delx.au/gnu-emacs/commitdiff_plain/f37e01634cc3ea6561fc031fd09912ed4b732820

(Programming Tips): Add conventions for minibuffer questions and prompts.
---

diff --git a/lispref/tips.texi b/lispref/tips.texi
index 46eb887dce..d651eb95f0 100644
--- a/lispref/tips.texi
+++ b/lispref/tips.texi
@@ -373,6 +373,20 @@ or @code{beep} to report errors.
 An error message should start with a capital letter but should not end
 with a period.
 
+@item
+A question asked in the minibuffer with @code{y-or-n-p} or
+@code{yes-or-no-p} should start with a capital letter and end with
+@samp{? }.
+
+@item
+When you mention a default value in a minibuffer prompt,
+put it and the word @samp{default} inside parentheses.
+It should look like this:
+
+@example
+Enter the answer: (default 42)
+@end example
+
 @item
 In @code{interactive}, if you use a Lisp expression to produce a list
 of arguments, don't try to provide the ``correct'' default values for