diff options
| author | Chong Yidong <[email protected]> | 2010-08-22 15:30:26 -0400 |
|---|---|---|
| committer | Chong Yidong <[email protected]> | 2010-08-22 15:30:26 -0400 |
| commit | bc7d7ea63ba9d98b3ecc3b6decf4392a651dcbfb (patch) | |
| tree | 5780ba9db2ad2249e4f2a401bc96952181a7c3a4 /doc/lispref/modes.texi | |
| parent | 41a20de9f4bc77586ed2e7cb4c21cb7f89baaea8 (diff) | |
Doc fix for define-minor-mode (Bug#6880).
* doc/lispref/modes.texi (Defining Minor Modes): Doc fix (Bug#6880).
* emacs-lisp/easy-mmode.el (define-minor-mode): Doc fix (Bug#6880).
Diffstat (limited to 'doc/lispref/modes.texi')
| -rw-r--r-- | doc/lispref/modes.texi | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 3953da59b9..12f16b6766 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -1411,14 +1411,20 @@ The string @var{lighter} says what to display in the mode line when the mode is enabled; if it is @code{nil}, the mode is not displayed in the mode line. -The optional argument @var{keymap} specifies the keymap for the minor mode. -It can be a variable name, whose value is the keymap, or it can be an alist -specifying bindings in this form: +The optional argument @var{keymap} specifies the keymap for the minor +mode. If non-@code{nil}, it should be a variable name (whose value is +a keymap), a keymap, or an alist of the form @example (@var{key-sequence} . @var{definition}) @end example +@noindent +where each @var{key-sequence} and @var{definition} are arguments +suitable for passing to @code{define-key} (@pxref{Changing Key +Bindings}). If @var{keymap} is a keymap or an alist, this also +defines the variable @code{@var{mode}-map}. + The above three arguments @var{init-value}, @var{lighter}, and @var{keymap} can be (partially) omitted when @var{keyword-args} are used. The @var{keyword-args} consist of keywords followed by |