diff options
| author | Richard M. Stallman | 2005-09-04 01:48:26 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2005-09-04 01:48:26 +0000 |
| commit | f37e01634cc3ea6561fc031fd09912ed4b732820 (patch) | |
| tree | 2188fcb813ca1e4125f15efcc357064df64eae70 | |
| parent | 0c6087a609a6042e3daea9d1fa27c140c992952c (diff) | |
| download | emacs-f37e01634cc3ea6561fc031fd09912ed4b732820.tar.gz emacs-f37e01634cc3ea6561fc031fd09912ed4b732820.zip | |
(Programming Tips): Add conventions for minibuffer questions and prompts.
| -rw-r--r-- | lispref/tips.texi | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/lispref/tips.texi b/lispref/tips.texi index 46eb887dce8..d651eb95f0e 100644 --- a/lispref/tips.texi +++ b/lispref/tips.texi | |||
| @@ -374,6 +374,20 @@ An error message should start with a capital letter but should not end | |||
| 374 | with a period. | 374 | with a period. |
| 375 | 375 | ||
| 376 | @item | 376 | @item |
| 377 | A question asked in the minibuffer with @code{y-or-n-p} or | ||
| 378 | @code{yes-or-no-p} should start with a capital letter and end with | ||
| 379 | @samp{? }. | ||
| 380 | |||
| 381 | @item | ||
| 382 | When you mention a default value in a minibuffer prompt, | ||
| 383 | put it and the word @samp{default} inside parentheses. | ||
| 384 | It should look like this: | ||
| 385 | |||
| 386 | @example | ||
| 387 | Enter the answer: (default 42) | ||
| 388 | @end example | ||
| 389 | |||
| 390 | @item | ||
| 377 | In @code{interactive}, if you use a Lisp expression to produce a list | 391 | In @code{interactive}, if you use a Lisp expression to produce a list |
| 378 | of arguments, don't try to provide the ``correct'' default values for | 392 | of arguments, don't try to provide the ``correct'' default values for |
| 379 | region or position arguments. Instead, provide @code{nil} for those | 393 | region or position arguments. Instead, provide @code{nil} for those |