bug-gnu-emacs
[Top][All Lists]
Advanced

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

bug#26998: 25.2; Please don't curly quote example code in docstring.


From: Glenn Morris
Subject: bug#26998: 25.2; Please don't curly quote example code in docstring.
Date: Fri, 19 May 2017 15:39:51 -0400
User-agent: Gnus (www.gnus.org), GNU Emacs (www.gnu.org/software/emacs/)

Thierry Volpiatto wrote:

> When copying/pasting example code with quotes from a docstring, user have
> to replace curly quotes "'" by real quote "'" before evaling code which
> is a regression IMO.
>
> e.g     
>    (defvar bar 1)
>    (foo 'bar)

Is the above supposed to be part of a doc-string?
A complete example is always helpful:

(defvar my-var nil
 "Blah.
Do stuff:
  (defvar bar 1)
  (foo \\='bar)
  (foo 'bar)
")
C-h v my-var

So I guess all existing lisp doc-strings everywhere are supposed to be
audited for use of ' and \= escapes added where needed.
(I believe it has been done for code in Emacs.)
This has been discussed several times over on this and other Emacs lists,
so there probably isn't anything new left to say.





reply via email to

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