summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard M. Stallman <rms@gnu.org>2006-06-16 15:22:59 +0000
committerRichard M. Stallman <rms@gnu.org>2006-06-16 15:22:59 +0000
commitcfbd1a6f5587f013da7c891b904bf19dd8390878 (patch)
tree0be5546cc57c175fcd0121dbb0ca6fe1847ef1ed
parent55111a5638acea8b38cca671af7bbc2d47dbff52 (diff)
downloademacs-cfbd1a6f5587f013da7c891b904bf19dd8390878.tar.gz
(Coding Conventions): Better explain conventions for definition constructs.
-rw-r--r--lispref/tips.texi13
1 files changed, 8 insertions, 5 deletions
diff --git a/lispref/tips.texi b/lispref/tips.texi
index 6ad1c166e5b..37461398473 100644
--- a/lispref/tips.texi
+++ b/lispref/tips.texi
@@ -204,11 +204,14 @@ say which functions are replaced, and how the behavior of the
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