aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/lispref/tips.texi12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index 30146a89ebf..d03698d354f 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -689,6 +689,18 @@ line. This looks nice in the source code, but looks bizarre when users
689view the documentation. Remember that the indentation before the 689view the documentation. Remember that the indentation before the
690starting double-quote is not part of the string! 690starting double-quote is not part of the string!
691 691
692@item
693When documentation should display an ASCII apostrophe or grave accent,
694use @samp{\\='} or @samp{\\=`} in the documentation string literal so
695that the character is displayed as-is.
696
697@item
698In documentation strings, do not quote expressions that are not Lisp symbols,
699as these expressions can stand for themselves. For example, write
700@samp{Return the list (NAME TYPE RANGE) ...}@: instead of
701@samp{Return the list `(NAME TYPE RANGE)' ...}@: or
702@samp{Return the list \\='(NAME TYPE RANGE) ...}.
703
692@anchor{Docstring hyperlinks} 704@anchor{Docstring hyperlinks}
693@item 705@item
694@cindex curly quotes 706@cindex curly quotes