From: Lars Ingebrigtsen <larsi@gnus.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: Stefan Kangas <stefan@marxist.se>, 49007@debbugs.gnu.org
Subject: bug#49007: 28.0.50; "docstring wider than 80" misfire
Date: Mon, 14 Jun 2021 15:47:10 +0200 [thread overview]
Message-ID: <87czsozhgh.fsf@gnus.org> (raw)
In-Reply-To: <jwvsg1ly7v4.fsf@iro.umontreal.ca> (Stefan Monnier's message of "Sun, 13 Jun 2021 13:47:27 -0400")
Stefan Monnier <monnier@iro.umontreal.ca> writes:
> Byte-compiling the declaration below complains that
>
> defalias `rudel-connect' docstring wider than 80 characters
>
> even though it stays within the 80 columns limit.
>
> Stefan
>
> (cl-defgeneric rudel-connect ((this rudel-protocol-backend) transport
> info info-callback
> &optional progress-callback)
> "Create a new connection through TRANSPORT according to the data in INFO.
Hm... the warning comes from the arglist being too long, which it
indeed is:
(documentation 'rudel-connect)
=>
"Create a new connection through TRANSPORT according to the data in INFO.
[...]
Implementations can rely on the fact that the property :session
in INFO contains the ‘rudel-session’ object to which the new
connection will be associated.
(fn (THIS rudel-protocol-backend) TRANSPORT INFO INFO-CALLBACK &optional PROGRESS-CALLBACK)"
Which comes from `help--make-usage-docstring'. However, when displaying
the help, this `fn' bit is then massaged and folded (and placed at the
start).
So perhaps the correct fix here is to have the docstring width checker
ignore those parts?
Any opinions?
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
next prev parent reply other threads:[~2021-06-14 13:47 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-13 17:47 bug#49007: 28.0.50; "docstring wider than 80" misfire Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-06-14 13:47 ` Lars Ingebrigtsen [this message]
2021-06-14 14:47 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-06-15 13:34 ` Lars Ingebrigtsen
2021-06-15 15:54 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
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=87czsozhgh.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=49007@debbugs.gnu.org \
--cc=monnier@iro.umontreal.ca \
--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).