]> git.eshelyaron.com Git - emacs.git/commitdiff
Document that variables should not be called -p
authorKaushal Modi <kaushal.modi@gmail.com>
Sat, 12 Oct 2019 20:26:50 +0000 (22:26 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sat, 12 Oct 2019 20:26:50 +0000 (22:26 +0200)
* doc/lispref/tips.texi (Coding Conventions): Document that
variables should now be called -p (bug#26564).

doc/lispref/tips.texi

index 6d84cfef53b845014bccd3f3ad71857f815793ec..9f6420949de326ca751cda6bb9d4af0dbe7030a9 100644 (file)
@@ -158,7 +158,9 @@ 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}.
+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}).
 
 @item
 If the purpose of a variable is to store a single function, give it a