From 05df70e755f72b7a4c7b7d94ca2349f1c5c67968 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 3 Jun 2022 13:04:13 +0200 Subject: [PATCH] Revert the `...' documentation back to actual usage MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit * 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 1ed9c1c7f9fe32ff5123091033350beb1ccae4ca) --- doc/lispref/tips.texi | 26 ++++++++++---------------- 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index 1b256f752a3..a3f49c19bce 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi @@ -687,26 +687,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 -- 2.39.2