summaryrefslogtreecommitdiff
path: root/doc/lispref/tips.texi
diff options
context:
space:
mode:
authorKaushal Modi <kaushal.modi@gmail.com>2019-10-12 22:26:50 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2019-10-12 22:26:50 +0200
commit6bc938712fa5eb10b383d71c7a76572e99a6ab91 (patch)
tree48470c207226dbc77049a00c16c5f40315c55a91 /doc/lispref/tips.texi
parent043d88862c43cebe2a29efa56816244db3df4dd2 (diff)
downloademacs-6bc938712fa5eb10b383d71c7a76572e99a6ab91.tar.gz
Document that variables should not be called -p
* doc/lispref/tips.texi (Coding Conventions): Document that variables should now be called -p (bug#26564).
Diffstat (limited to 'doc/lispref/tips.texi')
-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
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