]> git.eshelyaron.com Git - emacs.git/commitdiff
Document the 'list-FOO' convention
authorEli Zaretskii <eliz@gnu.org>
Fri, 22 Sep 2017 09:41:00 +0000 (12:41 +0300)
committerEli Zaretskii <eliz@gnu.org>
Fri, 22 Sep 2017 09:41:00 +0000 (12:41 +0300)
* doc/lispref/tips.texi (Coding Conventions): Document the
list-FOO convention.

doc/lispref/tips.texi

index bed3bed95bd94f6f823d5197c6ee19c48eab19a8..17fd4a1027e4592f7a7fe6431245d050509ec486 100644 (file)
@@ -68,10 +68,13 @@ costs.}.  Use two hyphens to separate prefix and name if the symbol is
 not meant to be used by other packages.
 
 Occasionally, for a command name intended for users to use, it is more
-convenient if some words come before the package's name prefix.  And
-constructs that define functions, variables, etc., work better if they
-start with @samp{defun} or @samp{defvar}, so put the name prefix later
-on in the name.
+convenient if some words come before the package's name prefix.  For
+example, it is our convention to have commands that list objects named
+as @samp{list-@var{something}}, e.g., a package called @samp{frob}
+could have a command @samp{list-frobs}, when its other global symbols
+begin with @samp{frob-}.  Also, constructs that define functions,
+variables, etc., work better if they start with @samp{defun} or
+@samp{defvar}, so put the name prefix later on in the name.
 
 This recommendation applies even to names for traditional Lisp
 primitives that are not primitives in Emacs Lisp---such as