changeset 9807:d5fa87d62d62

Add function and variable name conventions.
author Richard M. Stallman <rms@gnu.org>
date Tue, 01 Nov 1994 21:04:29 +0000
parents 7542dbfaea18
children 4c43c9dbe130
files lispref/tips.texi
diffstat 1 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/tips.texi	Tue Nov 01 19:27:21 1994 +0000
+++ b/lispref/tips.texi	Tue Nov 01 21:04:29 1994 +0000
@@ -74,6 +74,16 @@
 @code{run-hooks}, just as the existing major modes do.  @xref{Hooks}.
 
 @item
+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}.  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}.
+
+@item
+If a user option variable records a true-or-false condition, give it a
+name that ends in @samp{-flag}.
+
+@item
 Please do not define @kbd{C-c @var{letter}} as a key in your major
 modes.  These sequences are reserved for users; they are the
 @strong{only} sequences reserved for users, so we cannot do without