# HG changeset patch # User Richard M. Stallman # Date 1150471379 0 # Node ID 706e41b8c07f1178a4fe1ecd44a56b75aaa1f46b # Parent a358bd87a24245e113377f7d355d7f2c025cb265 (Coding Conventions): Better explain conventions for definition constructs. diff -r a358bd87a242 -r 706e41b8c07f lispref/tips.texi --- 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