]> git.eshelyaron.com Git - emacs.git/commitdiff
; Minor copyedits in a recent ELisp manual change.
authorEli Zaretskii <eliz@gnu.org>
Sun, 13 Oct 2019 07:59:18 +0000 (10:59 +0300)
committerEli Zaretskii <eliz@gnu.org>
Sun, 13 Oct 2019 07:59:18 +0000 (10:59 +0300)
* doc/lispref/tips.texi (Coding Conventions): Make the
guideline against '-p' in variable names less mandatory and
more constructive.

doc/lispref/tips.texi

index 9f6420949de326ca751cda6bb9d4af0dbe7030a9..eb0381647523c6abaec1da000c529e27cf38c647 100644 (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