From: Mauro Aranda <maurooaranda@gmail.com>
To: 4110@debbugs.gnu.org
Cc: Lennart Borgman <lennart.borgman@gmail.com>
Subject: bug#4110: 23.1.50; Checkdoc should recognize "minor mode"
Date: Mon, 08 Mar 2021 09:04:19 -0300 [thread overview]
Message-ID: <604612c7.1c69fb81.bb823.da84@mx.google.com> (raw)
In-Reply-To: <e01d8a50909131521l5d469342t3f739de5d0628d29@mail.gmail.com> (Lennart Borgman's message of "Mon, 14 Sep 2009 00:21:07 +0200")
Lennart Borgman <lennart.borgman@gmail.com> writes:
> You can write "function `my-mode'" or "variable `my-mode'" in a doc
> string to make checkdoc happy. However I would like to write "minor
> mode `my-mode'" instead since it is more clear. And I think the
> `my-mode' link should go to the function since that is wher the doc
> string from define-minor-mode shows up.
The change to allow this should be pretty simple: just add "mode" to the
list of suggested words.
But I do wonder if instead checkdoc should be happy just with the symbol
ending with "-mode". IOW, I tend to think that there is no ambiguity
in "`my-mode'" in a docstring, even if my-mode is defined as a variable
and as a function.
Any opinions?
next prev parent reply other threads:[~2021-03-08 12:04 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-09-13 20:26 bug#4110: 23.1.50; Checkdoc should recognize "minor mode" Chong Yidong
2009-09-13 22:21 ` Lennart Borgman
2021-03-08 12:04 ` Mauro Aranda [this message]
2021-08-27 3:10 ` Lars Ingebrigtsen
2021-09-24 21:45 ` Stefan Kangas
-- strict thread matches above, loose matches on Subject: below --
2009-08-10 21:49 Lennart Borgman
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=604612c7.1c69fb81.bb823.da84@mx.google.com \
--to=maurooaranda@gmail.com \
--cc=4110@debbugs.gnu.org \
--cc=lennart.borgman@gmail.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).