[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Symbol quotation in doc strings

From: Ikumi Keita
Subject: Symbol quotation in doc strings
Date: Mon, 30 May 2022 01:56:16 +0900

Hi Arash,

In recent commits 6fe2f21e and 3447aa75 about doc strings, several
references on elisp symbols were converted like this:
@@ -5661,7 +5661,7 @@ characters."
-DIRECTION can be indicated by the symbols 'forward and 'backward.
+DIRECTION can be indicated by the symbols \\='forward and \\='backward.
However, info node `(elisp) Documentation Tips' directs to quote elisp
symbol in ‘this style’ or `this style' rather than "\='" quoting:
|    • 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 (‘..’).
|   [...]
|      Documentation strings can also use an older single-quoting
|      convention, which quotes symbols with grave accent ` and apostrophe
|      ': `like-this' rather than ‘like-this’.
So I think it would be more appropriate to follow this convention. Is
there any circumstances I'm missing?

Ikumi Keita
#StandWithUkraine #StopWarInUkraine

reply via email to

[Prev in Thread] Current Thread [Next in Thread]