Mercurial > emacs
changeset 71375:706e41b8c07f
(Coding Conventions): Better explain conventions for definition constructs.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Fri, 16 Jun 2006 15:22:59 +0000 |
| parents | a358bd87a242 |
| children | a072975edac0 |
| files | lispref/tips.texi |
| diffstat | 1 files changed, 8 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/lispref/tips.texi Fri Jun 16 15:21:54 2006 +0000 +++ b/lispref/tips.texi Fri Jun 16 15:22:59 2006 +0000 @@ -204,11 +204,14 @@ replacements differs from that of the originals. @item -Avoid using macros that define functions and variables with names that -are constructed. It is best for maintenance when the name of the -function or variable being defined is given explicitly in the source -code, as the second element of the list---as it is when you use -@code{defun}, @code{defalias}, @code{defvar} and @code{defcustom}. +Constructs that define a function or variable should be macros, +not functions, and their names should start with @samp{def}. + +@item +Macros that define a functions or variables should take the name to be +defined as the first argument. That will help various tools find the +definition automatically. Avoid constructing the names in the macro +itself, since that would confuse these tools. @item Please keep the names of your Emacs Lisp source files to 13 characters