emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re:Re: [elpa] externals/vertico-posframe 39dbdfe 6/7: Fix checkdoc warn.


From: tumashu
Subject: Re:Re: [elpa] externals/vertico-posframe 39dbdfe 6/7: Fix checkdoc warn.
Date: Fri, 29 Oct 2021 11:18:10 +0800 (CST)
















At 2021-10-29 11:07:37, "Stefan Monnier" <monnier@iro.umontreal.ca> wrote:
>ELPA Syncer [2021-10-28 21:57:54] wrote:
>>     Fix checkdoc warn.
>[...]
>> -  "Advice function of `minibuffer-message'"
>> +  "Advice function of `minibuffer-message'.
>> +Argument MESSAGE ."
>
>I think this fix is worse than the checkdoc warning.
>In my experience checkdoc's warning about arguments not mentioned in the
>docstring aren't very helpful (it's quite common that the arguments
>aren't mentioned.  Here for example, it's the same args as those of
>`minibuffer-message`, so there's no strong need to repeat the doc here.
>Also the function could come without docstring in which case
>checkdoc wouldn't complain about that missing arg doc).
>
>Maybe we should change checkdoc not to request args be mentioned?
>Or at least not for non-interactive functions?

agree :-)

>
>
>        Stefan

reply via email to

[Prev in Thread] Current Thread [Next in Thread]