procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Revert the `...' documentation back to actual usage

Browse source 
* doc/lispref/tips.texi (Documentation Tips): Document how `...'
is really used now (bug#55780).  ‘...’ is not really used in the
Emacs sources.

(cherry picked from commit 1ed9c1c7f9)
This commit is contained in:
Lars Ingebrigtsen 2022-06-03 13:04:13 +02:00 • committed by Stefan Kangas
parent 23112f89f9
commit 05df70e755
1 changed files with 10 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
doc/lispref/tips.texi
View file

@ -687,26 +687,20 @@ starting double-quote is not part of the string!
@cindex curly quotes @cindex curly quotes
@cindex curved quotes @cindex curved quotes
When a documentation string refers to a Lisp symbol, write it as it When a documentation string refers to a Lisp symbol, write it as it
would be printed (which usually means in lower case), surrounding it would be printed (which usually means in lower case), with a grave
with curved single quotes (@t{‘..’}). There are two exceptions: write accent @samp{`} before and apostrophe @samp{'} after it. There are
@code{t} and @code{nil} without surrounding punctuation. For example: two exceptions: write @code{t} and @code{nil} without surrounding
punctuation. For example:
@example @example
CODE can be ‘lambda’, nil, or t. CODE can be `lambda', nil, or t.
@end example @end example
@noindent Note that when Emacs displays these doc strings, Emacs will usually
@xref{Quotation Marks,,, emacs, The GNU Emacs Manual}, for how to display @samp{`} (grave accent) as @samp{‘} (left single quotation
enter curved single quotes. mark) and @samp{'} (apostrophe) as @samp{’} (right single quotation
mark), if the display supports displaying these characters.
Documentation strings can also use an older single-quoting convention, @xref{Keys in Documentation}.
which quotes symbols with grave accent @t{`} and apostrophe
@t{'}: @t{`like-this'} rather than @t{‘like-this’}. This
older convention was designed for now-obsolete displays in which grave
accent and apostrophe were mirror images.
Documentation using this convention is converted to the user's
preferred format when it is copied into a help buffer. @xref{Keys in
Documentation}.
@cindex hyperlinks in documentation strings @cindex hyperlinks in documentation strings
Help mode automatically creates a hyperlink when a documentation string Help mode automatically creates a hyperlink when a documentation string