[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: "Non-nil means" versus "On means" in docstrings
From: |
Eli Zaretskii |
Subject: |
Re: "Non-nil means" versus "On means" in docstrings |
Date: |
Fri, 28 Oct 2005 10:31:17 +0200 |
> Date: Thu, 27 Oct 2005 15:29:59 -0700
> From: Bill Wohler <address@hidden>
>
> ;; 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.