Re: Silence checkdoc for symbols designating major and minor modes

[Eli Zaretskii]

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