mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-30 12:21:25 -08:00
Code Issues Projects Releases Wiki Activity

Note guideline for doc string expressions

Browse source 
* doc/lispref/tips.texi (Documentation Tips):
Mention \\=' and \\=` and say that expressions like
(NAME TYPE RANGE) should not be quoted.
This commit is contained in:
Paul Eggert 2022-07-25 12:59:26 -07:00
parent 0f9c28f008
commit d04701c0c4
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/lispref/tips.texi
View file

@ -689,6 +689,18 @@ line. This looks nice in the source code, but looks bizarre when users
view the documentation. Remember that the indentation before the
starting double-quote is not part of the string!
@item
When documentation should display an ASCII apostrophe or grave accent,
use @samp{\\='} or @samp{\\=`} in the documentation string literal so
that the character is displayed as-is.
@item
In documentation strings, do not quote expressions that are not Lisp symbols,
as these expressions can stand for themselves. For example, write
@samp{Return the list (NAME TYPE RANGE) ...}@: instead of
@samp{Return the list `(NAME TYPE RANGE)' ...}@: or
@samp{Return the list \\='(NAME TYPE RANGE) ...}.
@anchor{Docstring hyperlinks}
@item
@cindex curly quotes