GNU bug report logs - #49007
28.0.50; "docstring wider than 80" misfire

Previous Next

Full log

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Stefan Kangas <stefan <at> marxist.se>, 49007 <at> debbugs.gnu.org
Subject: Re: bug#49007: 28.0.50; "docstring wider than 80" misfire
Date: Mon, 14 Jun 2021 15:47:10 +0200

Stefan Monnier <monnier <at> 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

Previous Next

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