emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] master 6bc9387: Document that variables should not be call


From: Lars Ingebrigtsen
Subject: [Emacs-diffs] master 6bc9387: Document that variables should not be called -p
Date: Sat, 12 Oct 2019 16:26:58 -0400 (EDT)

branch: master
commit 6bc938712fa5eb10b383d71c7a76572e99a6ab91
Author: Kaushal Modi <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>

    Document that variables should not be called -p
    
    * doc/lispref/tips.texi (Coding Conventions): Document that
    variables should now be called -p (bug#26564).
---
 doc/lispref/tips.texi | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index 6d84cfe..9f64209 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]