From: Philip Kaludercic <philipk@posteo.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: Silence checkdoc for symbols designating major and minor modes
Date: Fri, 30 Jul 2021 11:17:15 +0000 [thread overview]
Message-ID: <8735rwnj9g.fsf@posteo.net> (raw)
In-Reply-To: <83eebito8f.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 28 Jul 2021 19:08:48 +0300")
Eli Zaretskii <eliz@gnu.org> writes:
>> From: Philip Kaludercic <philipk@posteo.net>
>> Cc: emacs-devel@gnu.org
>> Date: Wed, 28 Jul 2021 14:46:57 +0000
>>
>> (defcustom rcirc-omit-responses
>> '("JOIN" "PART" "QUIT" "NICK")
>> "Responses which will be hidden when `rcirc-omit-mode' is enabled."
>> :type '(repeat string))
>>
>> triggering this response:
>>
>> Disambiguate rcirc-omit-mode by preceding w/ function,command,variable,option or symbol.
>
> FWIW, I think this warning should be removed wholesale. It is too
> harsh to require such finesses in doc strings.
I am inclined to agree, as in my experience, I have only ever seen
false-positives being highlighted by this rule.
> But if we want to keep it, I think we should include in the regexp
> also the "enabled" and "disabled" part that follows it. Just
> exempting "-mode" sounds too general for a heuristic.
--
Philip Kaludercic
next prev parent reply other threads:[~2021-07-30 11:17 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
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 [this message]
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=8735rwnj9g.fsf@posteo.net \
--to=philipk@posteo.net \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
/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).