]> git.eshelyaron.com Git - emacs.git/commitdiff
Revert the `...' documentation back to actual usage
authorLars Ingebrigtsen <larsi@gnus.org>
Fri, 3 Jun 2022 11:04:13 +0000 (13:04 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Fri, 3 Jun 2022 11:04:13 +0000 (13:04 +0200)
* doc/lispref/tips.texi (Documentation Tips): Document how `...'
is really used now (bug#55780).  ‘...’ is not really used in the
Emacs sources.

doc/lispref/tips.texi

index 061a5d672eccfd5046c63013c7bc45b3b4d25cdc..823255022099c1518a924ca9daaf13f72626625f 100644 (file)
@@ -694,26 +694,20 @@ starting double-quote is not part of the string!
 @cindex curly quotes
 @cindex curved quotes
 When a documentation string refers to a Lisp symbol, write it as it
-would be printed (which usually means in lower case), surrounding it
-with curved single quotes (@t{‘..’}).  There are two exceptions: write
-@code{t} and @code{nil} without surrounding punctuation.  For example:
+would be printed (which usually means in lower case), with a grave
+accent @samp{`} before and apostrophe @samp{'} after it.  There are
+two exceptions: write @code{t} and @code{nil} without surrounding
+punctuation.  For example:
 
 @example
- CODE can be ‘lambda’, nil, or t.
+ CODE can be `lambda', nil, or t.
 @end example
 
-@noindent
-@xref{Quotation Marks,,, emacs, The GNU Emacs Manual}, for how to
-enter curved single quotes.
-
-Documentation strings can also use an older single-quoting convention,
-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}.
+Note that when Emacs displays these doc strings, Emacs will usually
+display @samp{`} (grave accent) as @samp{‘} (left single quotation
+mark) and @samp{'} (apostrophe) as @samp{’} (right single quotation
+mark), if the display supports displaying these characters.
+@xref{Keys in Documentation}.
 
 @cindex hyperlinks in documentation strings
 Help mode automatically creates a hyperlink when a documentation string