aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2017-09-22 12:41:00 +0300
committerEli Zaretskii2017-09-22 12:41:00 +0300
commit0273916618f33ffd56b861cea187e9df337b8e2d (patch)
tree89999c2a23ce6d03761c06bcbf6da0d71fdb87c6
parentd24ec5854098841388dfecf2c668e7f48f348af0 (diff)
downloademacs-0273916618f33ffd56b861cea187e9df337b8e2d.tar.gz
emacs-0273916618f33ffd56b861cea187e9df337b8e2d.zip
Document the 'list-FOO' convention
* doc/lispref/tips.texi (Coding Conventions): Document the list-FOO convention.
-rw-r--r--doc/lispref/tips.texi11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index bed3bed95bd..17fd4a1027e 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -68,10 +68,13 @@ costs.}. Use two hyphens to separate prefix and name if the symbol is
68not meant to be used by other packages. 68not meant to be used by other packages.
69 69
70Occasionally, for a command name intended for users to use, it is more 70Occasionally, for a command name intended for users to use, it is more
71convenient if some words come before the package's name prefix. And 71convenient if some words come before the package's name prefix. For
72constructs that define functions, variables, etc., work better if they 72example, it is our convention to have commands that list objects named
73start with @samp{defun} or @samp{defvar}, so put the name prefix later 73as @samp{list-@var{something}}, e.g., a package called @samp{frob}
74on in the name. 74could have a command @samp{list-frobs}, when its other global symbols
75begin with @samp{frob-}. Also, constructs that define functions,
76variables, etc., work better if they start with @samp{defun} or
77@samp{defvar}, so put the name prefix later on in the name.
75 78
76This recommendation applies even to names for traditional Lisp 79This recommendation applies even to names for traditional Lisp
77primitives that are not primitives in Emacs Lisp---such as 80primitives that are not primitives in Emacs Lisp---such as