GNU bug report logs - #26998
25.2; Please don't curly quote example code in docstring.

Previous Next

Package: emacs;

Reported by: Thierry Volpiatto <thierry.volpiatto <at> gmail.com>

Date: Fri, 19 May 2017 18:40:02 UTC

Severity: minor

Tags: notabug

Found in version 25.2

Done: npostavs <at> users.sourceforge.net

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: Glenn Morris <rgm <at> gnu.org>
To: Thierry Volpiatto <thierry.volpiatto <at> gmail.com>
Cc: 26998 <at> debbugs.gnu.org
Subject: bug#26998: 25.2; Please don't curly quote example code in docstring.
Date: Fri, 19 May 2017 15:39:51 -0400

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.
This bug report was last modified 7 years and 293 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.