GNU bug report logs - #55773
Emacs 29.0.50:: allow single-quoted chars in docstring

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 55773 in the body.
You can then email your comments to 55773 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Andreas Röhler <andreas.roehler <at> easy-emacs.de>
To: bug-gnu-emacs <at> gnu.org
Subject: Emacs 29.0.50:: allow single-quoted chars in docstring
Date: Thu, 2 Jun 2022 21:49:44 +0200

[Message part 1 (text/plain, inline)]

Need to display single-quoted chars in docstring dealing with Python code


result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f'
)

Example shown in

https://peps.python.org/pep-0008/#indentation

[Message part 2 (text/html, inline)]

Message #8 received at 55773 <at> debbugs.gnu.org (full text, mbox):

From: Phil Sainty <psainty <at> orcon.net.nz>
To: Andreas Röhler <andreas.roehler <at> easy-emacs.de>
Cc: 55773 <at> debbugs.gnu.org
Subject: Re: bug#55773: Emacs 29.0.50:: allow single-quoted chars in docstring
Date: Fri, 03 Jun 2022 11:25:29 +1200

On 2022-06-03 07:49, Andreas Röhler wrote:
> Need to display single-quoted chars in docstring

Nowadays you need to escape literal apostrophes in docstrings
like this:

result = some_function_that_takes_arguments(
    \\='a\\=', \\='b\\=', \\='c\\=',
    \\='d\\=', \\='e\\=', \\='f\\='
)

Setting `text-quoting-style' to grave will prevent you from getting
bitten by automated curly-quote substitutions in help buffers (but
of course won't help you to remember to escape things when writing
docstrings).

See also: (info "(elisp)Text Quoting Style")

Message #11 received at 55773 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Phil Sainty <psainty <at> orcon.net.nz>
Cc: 55773 <at> debbugs.gnu.org,
 Andreas Röhler <andreas.roehler <at> easy-emacs.de>
Subject: Re: bug#55773: Emacs 29.0.50:: allow single-quoted chars in docstring
Date: Fri, 03 Jun 2022 06:00:16 +0200

Phil Sainty <psainty <at> orcon.net.nz> writes:

> See also: (info "(elisp)Text Quoting Style")

So this works as designed, and is what the byte compilation warning says
("use \="), so I'm closing this bug report.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

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