From: Bill Wohler <wohler@newt.com>
Subject: Re: "Non-nil means" versus "On means" in docstrings
Date: Fri, 28 Oct 2005 15:08:46 -0700 [thread overview]
Message-ID: <871x25cn0x.fsf@olgas.newt.com> (raw)
In-Reply-To: 19831.1130516564@olgas.newt.com
Bill Wohler <wohler@newt.com> writes:
> Eli Zaretskii <eliz@gnu.org> wrote:
>
>> > Date: Thu, 27 Oct 2005 15:29:59 -0700
>> > From: Bill Wohler <wohler@newt.com>
>> >
>> > ;; If the variable has -flag in the name, make sure
>> > (if (and (string-match "-flag$" (car fp))
>> > - (not (looking-at "\"\\*?Non-nil\\s-+means\\s-+")))
>> > + (not (looking-at
>> > + "\"\\*?\\(Non-nil\\|On\\)\\s-+means\\s-+")))
>> > (checkdoc-create-error
>> > "Flag variable doc strings should usually start: Non-nil means"
>> > s (marker-position e) t))
>>
>> I don't have a strong opinion about this, but IMHO if we allow "On" as
>> well as "Non-nil", the message displayed if none of them is used
>> should mention both possibilities. You suggest to modify the code,
>> but not the message.
>
> I would be happy to modify the message too.
As well as (elisp) Documentation Tips.
--
Bill Wohler <wohler@newt.com> http://www.newt.com/wohler/ GnuPG ID:610BD9AD
Maintainer of comp.mail.mh FAQ and MH-E. Vote Libertarian!
If you're passed on the right, you're in the wrong lane.
next prev parent reply other threads:[~2005-10-28 22:08 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2005-10-27 22:29 "Non-nil means" versus "On means" in docstrings Bill Wohler
2005-10-28 8:31 ` Eli Zaretskii
2005-10-28 16:22 ` Bill Wohler
2005-10-28 22:08 ` Bill Wohler [this message]
2005-10-29 5:13 ` Richard M. Stallman
2005-10-29 7:59 ` Lennart Borgman
2005-10-29 20:33 ` Richard M. Stallman
2005-10-29 21:43 ` Kim F. Storm
2005-10-29 22:30 ` Lennart Borgman
2005-10-30 20:15 ` Bill Wohler
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=871x25cn0x.fsf@olgas.newt.com \
--to=wohler@newt.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).