]> code.delx.au - gnu-emacs/commitdiff
(Coding Conventions): Explain when the package's
authorRichard M. Stallman <rms@gnu.org>
Tue, 18 Apr 2006 21:10:14 +0000 (21:10 +0000)
committerRichard M. Stallman <rms@gnu.org>
Tue, 18 Apr 2006 21:10:14 +0000 (21:10 +0000)
prefix should appear later on (not at the start of the name).

lispref/tips.texi

index 8b03313927507f244ff7b8cbbaafce7f6dbc3a86..889ac3e6a6da919e6edbc0776c5db8885b169b5d 100644 (file)
@@ -56,9 +56,13 @@ distinguish your program from other Lisp programs.@footnote{The
 benefits of a Common Lisp-style package system are considered not to
 outweigh the costs.}  Then take care to begin the names of all global
 variables, constants, and functions in your program with the chosen
-prefix.  This helps avoid name conflicts.  (Occasionally, for a command
-name intended for users to use, it is cleaner if some words come
-before the package name prefix.)
+prefix.  This helps avoid name conflicts.
+
+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.
 
 This recommendation applies even to names for traditional Lisp
 primitives that are not primitives in Emacs Lisp---such as