[Emacs-diffs] emacs-26 0273916: Document the 'list-FOO' convention

[Eli Zaretskii]

branch: emacs-26
commit 0273916618f33ffd56b861cea187e9df337b8e2d
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>

    Document the 'list-FOO' convention
    
    * doc/lispref/tips.texi (Coding Conventions): Document the
    list-FOO convention.
---
 doc/lispref/tips.texi | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index bed3bed..17fd4a1 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
 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 @address@hidden, 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
address@hidden, 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