Update docs for `customize-mode'

* lisp/cus-edit.el (customize-mode): This function works with both major
and minor modes, make docstring and prompt reflect that (Bug #23649).

* doc/lispref/modes.texi (Derived Modes): Remove note about
customize-mode being experimental; it has been around since Emacs
22 (Bug #11299).

Co-authored-by: Drew Adams <drew.adams@oracle.com>
This commit is contained in:
Noam Postavsky 2016-06-25 13:12:11 -04:00
parent 4395aaacd4
commit f2536958ec
2 changed files with 9 additions and 9 deletions

View file

@ -794,10 +794,9 @@ if @var{parent} is @code{nil}. (Again, a @code{nil} value is
@item :group @item :group
If this is specified, the value should be the customization group for If this is specified, the value should be the customization group for
this mode. (Not all major modes have one.) Only the (still this mode. (Not all major modes have one.) The command
experimental and unadvertised) command @code{customize-mode} currently @code{customize-mode} uses this. @code{define-derived-mode} does
uses this. @code{define-derived-mode} does @emph{not} automatically @emph{not} automatically define the specified customization group.
define the specified customization group.
@end table @end table
Here is a hypothetical example: Here is a hypothetical example:

View file

@ -1072,9 +1072,10 @@ are shown; the contents of those subgroups are initially hidden."
;;;###autoload ;;;###autoload
(defun customize-mode (mode) (defun customize-mode (mode)
"Customize options related to the current major mode. "Customize options related to a major or minor mode.
If a prefix \\[universal-argument] was given (or if the current major mode has no known group), By default the current major mode is used. With a prefix
then prompt for the MODE to customize." argument or if the current major mode has no known group, prompt
for the MODE to customize."
(interactive (interactive
(list (list
(let ((completion-regexp-list '("-mode\\'")) (let ((completion-regexp-list '("-mode\\'"))
@ -1083,8 +1084,8 @@ then prompt for the MODE to customize."
major-mode major-mode
(intern (intern
(completing-read (if group (completing-read (if group
(format "Major mode (default %s): " major-mode) (format "Mode (default %s): " major-mode)
"Major mode: ") "Mode: ")
obarray obarray
'custom-group-of-mode 'custom-group-of-mode
t nil nil (if group (symbol-name major-mode)))))))) t nil nil (if group (symbol-name major-mode))))))))