aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaushal Modi2019-10-12 22:26:50 +0200
committerLars Ingebrigtsen2019-10-12 22:26:50 +0200
commit6bc938712fa5eb10b383d71c7a76572e99a6ab91 (patch)
tree48470c207226dbc77049a00c16c5f40315c55a91
parent043d88862c43cebe2a29efa56816244db3df4dd2 (diff)
downloademacs-6bc938712fa5eb10b383d71c7a76572e99a6ab91.tar.gz
emacs-6bc938712fa5eb10b383d71c7a76572e99a6ab91.zip
Document that variables should not be called -p
* doc/lispref/tips.texi (Coding Conventions): Document that variables should now be called -p (bug#26564).
-rw-r--r--doc/lispref/tips.texi4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index 6d84cfef53b..9f6420949de 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
158condition is true or false, give the function a name that ends in 158condition is true or false, give the function a name that ends in
159@samp{p} (which stands for ``predicate''). If the name is one word, 159@samp{p} (which stands for ``predicate''). If the name is one word,
160add just @samp{p}; if the name is multiple words, add @samp{-p}. 160add just @samp{p}; if the name is multiple words, add @samp{-p}.
161Examples are @code{framep} and @code{frame-live-p}. 161Examples are @code{framep} and @code{frame-live-p}. This predicate
162suffix should not be used in variable names (i.e., you should name a
163variable @code{foo-feature} instead of @code{foo-feature-p}).
162 164
163@item 165@item
164If the purpose of a variable is to store a single function, give it a 166If the purpose of a variable is to store a single function, give it a