summaryrefslogtreecommitdiff
path: root/lisp/custom.el
diff options
context:
space:
mode:
authorChong Yidong <cyd@gnu.org>2012-02-15 12:00:34 +0800
committerChong Yidong <cyd@gnu.org>2012-02-15 12:00:34 +0800
commitc3a70e2b95e4cf41b1a671f7d721f0ba4aaff679 (patch)
treee1632789ac2c8118ccac24691c4a91fe57109c55 /lisp/custom.el
parent9f26dc243268eddc252287ef1918970bf580e946 (diff)
downloademacs-c3a70e2b95e4cf41b1a671f7d721f0ba4aaff679.tar.gz
Doc updates for defvar, defconst, and defcustom.
* lisp/custom.el (defcustom): Doc fix; note use of defvar. * src/eval.c (Fdefvar, Fdefconst): Doc fix; note that the variable is marked as special. Also, starting docstrings with * is obsolete.
Diffstat (limited to 'lisp/custom.el')
-rw-r--r--lisp/custom.el6
1 files changed, 5 insertions, 1 deletions
diff --git a/lisp/custom.el b/lisp/custom.el
index 2d880d23955..810b78144a4 100644
--- a/lisp/custom.el
+++ b/lisp/custom.el
@@ -208,7 +208,11 @@ is unbound. The expression itself is also stored, so that
Customize can re-evaluate it later to get the standard value.
DOC is the variable documentation.
-The remaining arguments should have the form
+This macro uses `defvar' as a subroutine, which also marks the
+variable as \"special\", so that it is always dynamically bound
+even when `lexical-binding' is t.
+
+The remaining arguments to `defcustom' should have the form
[KEYWORD VALUE]...