; Minor copyedits in a recent ELisp manual change.

* doc/lispref/tips.texi (Coding Conventions): Make the
guideline against '-p' in variable names less mandatory and
more constructive.
This commit is contained in:
Eli Zaretskii 2019-10-13 10:59:18 +03:00
parent 0fcd6e320d
commit f113ae5922

View file

@ -158,9 +158,10 @@ If the purpose of a function is to tell you whether a certain
condition is true or false, give the function a name that ends in
@samp{p} (which stands for ``predicate''). If the name is one word,
add just @samp{p}; if the name is multiple words, add @samp{-p}.
Examples are @code{framep} and @code{frame-live-p}. This predicate
suffix should not be used in variable names (i.e., you should name a
variable @code{foo-feature} instead of @code{foo-feature-p}).
Examples are @code{framep} and @code{frame-live-p}. We recommend to
avoid using this @code{-p} suffix in boolean variable names, unless
the variable is bound to a predicate function; instead, use a
@code{-flag} suffix or names like @code{is-foo}.
@item
If the purpose of a variable is to store a single function, give it a