From: Eli Zaretskii <eliz@gnu.org>
To: Philip Kaludercic <philipk@posteo.net>
Cc: emacs-devel@gnu.org
Subject: Re: Silence checkdoc for symbols designating major and minor modes
Date: Wed, 28 Jul 2021 14:33:18 +0300 [thread overview]
Message-ID: <83tukeu0zl.fsf@gnu.org> (raw)
In-Reply-To: <87k0lbfmto.fsf@posteo.net> (message from Philip Kaludercic on Tue, 27 Jul 2021 21:50:43 +0000)
> From: Philip Kaludercic <philipk@posteo.net>
> Date: Tue, 27 Jul 2021 21:50:43 +0000
>
> an issue I have been having when documenting code is that checkdoc wants
> me to disambiguate symbols referring to major or minor modes. That
> usually means adding "function", "command" "variable", "option" or
> "symbol" but in my experience these usually do not fit. In fact, most of
> the time it is obvious what is meant when referring to a major/minor
> mode.
>
> ... Foo when `bar-mode' is active ...
>
> The patch I added below silences the disambiguation request when a
> symbol ends in "-mode". Alternatively, one could also add a "minor mode"
> and "major mode" to the list of accepted keywords, but I think that
> would sound to repetitive:
>
> ... Foo when minor mode `bar-mode' is active ...
>
> Opinions?
First, the code, if installed, should have a comment explaining why
these strings are being exempted.
More generally, could you please show an example of a doc string and
the warning(s) it triggers? I'm not sure I understand the problem
well enough to make up my mind. (Do all of our existing modes suffer
from this problem?)
Thanks.
next prev parent reply other threads:[~2021-07-28 11:33 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-27 21:50 Silence checkdoc for symbols designating major and minor modes Philip Kaludercic
2021-07-28 11:33 ` Eli Zaretskii [this message]
2021-07-28 14:46 ` Philip Kaludercic
2021-07-28 15:53 ` Lars Ingebrigtsen
2021-07-28 16:08 ` Eli Zaretskii
2021-07-30 11:17 ` Philip Kaludercic
2021-07-30 21:47 ` Stefan Monnier
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=83tukeu0zl.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=philipk@posteo.net \
/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).