emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Silence checkdoc for symbols designating major and minor modes


From: Eli Zaretskii
Subject: Re: Silence checkdoc for symbols designating major and minor modes
Date: Wed, 28 Jul 2021 19:08:48 +0300

> 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.

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.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]