diff options
| author | Richard M. Stallman | 2006-04-18 21:10:14 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2006-04-18 21:10:14 +0000 |
| commit | 8a1aafd01a88cda0df0873d3772487e2b0123769 (patch) | |
| tree | a4273eadd73589bc0ec880193bc97bef46ff75e8 | |
| parent | 50363cd8abab4ae76c1b15f8c98e23b566f7e277 (diff) | |
| download | emacs-8a1aafd01a88cda0df0873d3772487e2b0123769.tar.gz emacs-8a1aafd01a88cda0df0873d3772487e2b0123769.zip | |
(Coding Conventions): Explain when the package's
prefix should appear later on (not at the start of the name).
| -rw-r--r-- | lispref/tips.texi | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/lispref/tips.texi b/lispref/tips.texi index 8b033139275..889ac3e6a6d 100644 --- a/lispref/tips.texi +++ b/lispref/tips.texi | |||
| @@ -56,9 +56,13 @@ distinguish your program from other Lisp programs.@footnote{The | |||
| 56 | benefits of a Common Lisp-style package system are considered not to | 56 | benefits of a Common Lisp-style package system are considered not to |
| 57 | outweigh the costs.} Then take care to begin the names of all global | 57 | outweigh the costs.} Then take care to begin the names of all global |
| 58 | variables, constants, and functions in your program with the chosen | 58 | variables, constants, and functions in your program with the chosen |
| 59 | prefix. This helps avoid name conflicts. (Occasionally, for a command | 59 | prefix. This helps avoid name conflicts. |
| 60 | name intended for users to use, it is cleaner if some words come | 60 | |
| 61 | before the package name prefix.) | 61 | Occasionally, for a command name intended for users to use, it is more |
| 62 | convenient if some words come before the package's name prefix. And | ||
| 63 | constructs that define functions, variables, etc., work better if they | ||
| 64 | start with @samp{defun} or @samp{defvar}, so put the name prefix later | ||
| 65 | on in the name. | ||
| 62 | 66 | ||
| 63 | This recommendation applies even to names for traditional Lisp | 67 | This recommendation applies even to names for traditional Lisp |
| 64 | primitives that are not primitives in Emacs Lisp---such as | 68 | primitives that are not primitives in Emacs Lisp---such as |