changeset 63932:bbf23e50d797

(custom-add-option): Doc fix.
author Richard M. Stallman <rms@gnu.org>
date Sun, 03 Jul 2005 16:09:07 +0000
parents a166968798fa
children dd8f5792476e
files lisp/custom.el
diffstat 1 files changed, 4 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/custom.el	Sun Jul 03 16:08:19 2005 +0000
+++ b/lisp/custom.el	Sun Jul 03 16:09:07 2005 +0000
@@ -486,8 +486,10 @@
 (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)))))