From: Stefan Monnier <monnier@iro.umontreal.ca>
To: emacs-devel@gnu.org
Cc: Feng Shu <tumashu@163.com>
Subject: Re: [elpa] externals/vertico-posframe 39dbdfe 6/7: Fix checkdoc warn.
Date: Thu, 28 Oct 2021 23:07:37 -0400 [thread overview]
Message-ID: <jwvzgqsleht.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <20211029015754.E319220983@vcs0.savannah.gnu.org> (ELPA Syncer's message of "Thu, 28 Oct 2021 21:57:54 -0400 (EDT)")
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
next parent reply other threads:[~2021-10-29 3:07 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20211029015739.26727.26392@vcs0.savannah.gnu.org>
[not found] ` <20211029015754.E319220983@vcs0.savannah.gnu.org>
2021-10-29 3:07 ` Stefan Monnier [this message]
2021-10-29 3:18 ` Re:Re: [elpa] externals/vertico-posframe 39dbdfe 6/7: Fix checkdoc warn tumashu
2021-10-29 6:29 ` Eli Zaretskii
2021-10-29 10:43 ` Stefan Kangas
2021-10-29 13:42 ` Stefan Monnier
2021-10-29 13:57 ` Eli Zaretskii
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=jwvzgqsleht.fsf-monnier+emacs@gnu.org \
--to=monnier@iro.umontreal.ca \
--cc=emacs-devel@gnu.org \
--cc=tumashu@163.com \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.