[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#49007: 28.0.50; "docstring wider than 80" misfire
From: |
Lars Ingebrigtsen |
Subject: |
bug#49007: 28.0.50; "docstring wider than 80" misfire |
Date: |
Mon, 14 Jun 2021 15:47:10 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) |
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