summaryrefslogtreecommitdiff
path: root/doc/lispref/tips.texi
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2012-04-25 20:31:47 -0400
committerGlenn Morris <rgm@gnu.org>2012-04-25 20:31:47 -0400
commit16152b76a4f0fd82674479b64d923bd86aab5f24 (patch)
tree7f092a987de857a29a37dae62e2428ff56708186 /doc/lispref/tips.texi
parent84412f2cbb7f282c15857493602b80f60e562051 (diff)
downloademacs-16152b76a4f0fd82674479b64d923bd86aab5f24.tar.gz
Use Texinfo recommended convention for quotes+punctuation.
Diffstat (limited to 'doc/lispref/tips.texi')
-rw-r--r--doc/lispref/tips.texi14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index 5874a848807..56c361cf86e 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -641,7 +641,7 @@ have the form (KEY . VALUE). Here, KEY is ...
@item
Never change the case of a Lisp symbol when you mention it in a doc
-string. If the symbol's name is @code{foo}, write ``foo,'' not
+string. If the symbol's name is @code{foo}, write ``foo'', not
``Foo'' (which is a different symbol).
This might appear to contradict the policy of writing function
@@ -773,9 +773,9 @@ is indicative and has a proper subject.
@item
The documentation string for a function that is a yes-or-no predicate
-should start with words such as ``Return t if,'' to indicate
-explicitly what constitutes ``truth.'' The word ``return'' avoids
-starting the sentence with lower-case ``t,'' which could be somewhat
+should start with words such as ``Return t if'', to indicate
+explicitly what constitutes ``truth''. The word ``return'' avoids
+starting the sentence with lower-case ``t'', which could be somewhat
distracting.
@item
@@ -798,8 +798,8 @@ returned.''
@item
Avoid using the word ``cause'' (or its equivalents) unnecessarily.
-Instead of, ``Cause Emacs to display text in boldface,'' write just
-``Display text in boldface.''
+Instead of, ``Cause Emacs to display text in boldface'', write just
+``Display text in boldface''.
@item
Avoid using ``iff'' (a mathematics term meaning ``if and only if''),
@@ -822,7 +822,7 @@ to set, use @code{defcustom}. @xref{Defining Variables}.
@item
The documentation string for a variable that is a yes-or-no flag should
-start with words such as ``Non-nil means,'' to make it clear that
+start with words such as ``Non-nil means'', to make it clear that
all non-@code{nil} values are equivalent and indicate explicitly what
@code{nil} and non-@code{nil} mean.
@end itemize