From: Lars Ingebrigtsen <larsi@gnus.org>
To: Stefan Kangas <stefan@marxist.se>
Cc: 29003@debbugs.gnu.org, Radon Rosborough <radon.neon@gmail.com>,
"Charles A. Roelli" <charles@aurox.ch>
Subject: bug#29003: [python.el] Docstring from PEP 257 is filled incorrectly by Emacs
Date: Tue, 30 Nov 2021 15:56:59 +0100 [thread overview]
Message-ID: <87v909d744.fsf_-_@gnus.org> (raw)
In-Reply-To: <87tv7bqgii.fsf@marxist.se> (Stefan Kangas's message of "Mon, 11 Nov 2019 03:43:49 +0100")
Stefan Kangas <stefan@marxist.se> writes:
> > > def complex(real=0.0, imag=0.0):
> > > """Form a complex number.
> > >
> > > Keyword arguments:
> > > real -- the real part (default 0.0)
> > > imag -- the imaginary part (default 0.0)
> > > """
> > > if imag == 0.0 and real == 0.0:
> > > return complex_zero
> > > ...
[...]
>> is not modified when filled. The question is whether the example given
>> by PEP 257 should be considered "standard" syntax for introducing
>> keyword arguments, and whether such syntax should be supported by
>> Emacs in a similar way to how `python-docstring' supports reST syntax.
>
> I think this should ideally be supported by Emacs, but it should be
> configurable and disabled by default.
I think introducing these kinds of semantics in doc strings is
inherently brittle (unless really well-defined). For instance,
If this is a doc string, and then I
pause -- using a double dash for a
pause is common -- then we'd be filling
things differently.
So I don't think changing the pep-257 style would be appropriate, and I
think adding a user option for this wouldn't receive much use. So I'm
closing this bug report.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
prev parent reply other threads:[~2021-11-30 14:56 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-26 2:08 bug#29003: 25.3; Docstring from PEP 257 is filled incorrectly by Emacs Radon Rosborough
2017-10-26 19:03 ` Charles A. Roelli
2017-10-26 19:23 ` Radon Rosborough
2017-10-26 19:41 ` Charles A. Roelli
2019-11-11 2:43 ` Stefan Kangas
2021-11-30 14:56 ` Lars Ingebrigtsen [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87v909d744.fsf_-_@gnus.org \
--to=larsi@gnus.org \
--cc=29003@debbugs.gnu.org \
--cc=charles@aurox.ch \
--cc=radon.neon@gmail.com \
--cc=stefan@marxist.se \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).