From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: tumashu@163.com, emacs-devel@gnu.org
Subject: Re: [elpa] externals/vertico-posframe 39dbdfe 6/7: Fix checkdoc warn.
Date: Fri, 29 Oct 2021 16:57:29 +0300 [thread overview]
Message-ID: <83h7d0q6gm.fsf@gnu.org> (raw)
In-Reply-To: <jwvo878klgk.fsf-monnier+emacs@gnu.org> (message from Stefan Monnier on Fri, 29 Oct 2021 09:42:14 -0400)
> From: Stefan Monnier <monnier@iro.umontreal.ca>
> Cc: emacs-devel@gnu.org, tumashu@163.com
> Date: Fri, 29 Oct 2021 09:42:14 -0400
>
> > Many times people don't reference the arguments there because they are
> > unaware of our style conventions, or because they cannot find the
> > wording which would mention the arguments and still stay within the
> > 80-char limitation.
>
> Hmm... AFAIK this warning is unrelated to the first line or the 80
> columns conventions. It just says things like:
>
> Argument ‘prompt’ should appear (as PROMPT) in the doc string
People sometimes give up mentioning the arguments because they cannot
find good words to describe them. This pressure is higher for the
first line.
prev parent reply other threads:[~2021-10-29 13:57 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 ` [elpa] externals/vertico-posframe 39dbdfe 6/7: Fix checkdoc warn Stefan Monnier
2021-10-29 3:18 ` 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 [this message]
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83h7d0q6gm.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=monnier@iro.umontreal.ca \
--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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).