]> git.eshelyaron.com Git - emacs.git/commitdiff
(custom-add-option): Doc fix.
authorRichard M. Stallman <rms@gnu.org>
Sun, 3 Jul 2005 16:09:07 +0000 (16:09 +0000)
committerRichard M. Stallman <rms@gnu.org>
Sun, 3 Jul 2005 16:09:07 +0000 (16:09 +0000)
lisp/custom.el

index a438ee7d5fee03ba5b6530628c46786cd93f236a..cb4e76dd65a523e8de3fa51c423fe7ab45848078 100644 (file)
@@ -486,8 +486,10 @@ both appear in constructs like `custom-set-variables'."
 (defun custom-add-option (symbol option)
   "To the variable SYMBOL add OPTION.
 
-If SYMBOL is a hook variable, OPTION should be a hook member.
-For other types variables, the effect is undefined."
+If SYMBOL's custom type is a hook, OPTION should be a hook member.
+If SYMBOL's custom type is an alist, OPTION specifies a symbol
+to offer to the user as a possible key in the alist.
+For other custom types, this has no effect."
   (let ((options (get symbol 'custom-options)))
     (unless (member option options)
       (put symbol 'custom-options (cons option options)))))