Mercurial > emacs
comparison lispref/tips.texi @ 71957:61cb5aae3bc3
Put period and comma inside quotes.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 18 Jul 2006 00:08:15 +0000 |
parents | 0fa817d8a084 |
children | 3ee6ec714732 8a8e69664178 |
comparison
equal
deleted
inserted
replaced
71956:1caee6e0cbe1 | 71957:61cb5aae3bc3 |
---|---|
700 use @code{defvar} instead, start the doc string with a @samp{*}. | 700 use @code{defvar} instead, start the doc string with a @samp{*}. |
701 @xref{Defining Variables}. | 701 @xref{Defining Variables}. |
702 | 702 |
703 @item | 703 @item |
704 The documentation string for a variable that is a yes-or-no flag should | 704 The documentation string for a variable that is a yes-or-no flag should |
705 start with words such as ``Non-nil means@dots{}'', to make it clear that | 705 start with words such as ``Non-nil means,'' to make it clear that |
706 all non-@code{nil} values are equivalent and indicate explicitly what | 706 all non-@code{nil} values are equivalent and indicate explicitly what |
707 @code{nil} and non-@code{nil} mean. | 707 @code{nil} and non-@code{nil} mean. |
708 | 708 |
709 @item | 709 @item |
710 The documentation string for a function that is a yes-or-no predicate | 710 The documentation string for a function that is a yes-or-no predicate |
711 should start with words such as ``Return t if @dots{}'', to indicate | 711 should start with words such as ``Return t if,'' to indicate |
712 explicitly what constitutes ``truth''. The word ``return'' avoids | 712 explicitly what constitutes ``truth.'' The word ``return'' avoids |
713 starting the sentence with lower-case ``t'', which is somewhat | 713 starting the sentence with lower-case ``t,'' which could be somewhat |
714 distracting. | 714 distracting. |
715 | 715 |
716 @item | 716 @item |
717 When a function's documentation string mentions the value of an argument | 717 When a function's documentation string mentions the value of an argument |
718 of the function, use the argument name in capital letters as if it were | 718 of the function, use the argument name in capital letters as if it were |
734 have the form (KEY . VALUE). Here, KEY is ... | 734 have the form (KEY . VALUE). Here, KEY is ... |
735 @end example | 735 @end example |
736 | 736 |
737 @item | 737 @item |
738 Never change the case of a Lisp symbol when you mention it in a doc | 738 Never change the case of a Lisp symbol when you mention it in a doc |
739 string. If the symbol's name is @code{foo}, write ``foo'', not | 739 string. If the symbol's name is @code{foo}, write ``foo,'' not |
740 ``Foo'' (which is a different symbol). | 740 ``Foo'' (which is a different symbol). |
741 | 741 |
742 This might appear to contradict the policy of writing function | 742 This might appear to contradict the policy of writing function |
743 argument values, but there is no real contradiction; the argument | 743 argument values, but there is no real contradiction; the argument |
744 @emph{value} is not the same thing as the @emph{symbol} which the | 744 @emph{value} is not the same thing as the @emph{symbol} which the |