[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [elpa] externals/vertico-posframe 39dbdfe 6/7: Fix checkdoc warn.
From: |
Stefan Monnier |
Subject: |
Re: [elpa] externals/vertico-posframe 39dbdfe 6/7: Fix checkdoc warn. |
Date: |
Thu, 28 Oct 2021 23:07:37 -0400 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) |
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?
Stefan
- Re: [elpa] externals/vertico-posframe 39dbdfe 6/7: Fix checkdoc warn.,
Stefan Monnier <=