diff options
| author | Chong Yidong | 2010-08-22 15:30:26 -0400 |
|---|---|---|
| committer | Chong Yidong | 2010-08-22 15:30:26 -0400 |
| commit | bc7d7ea63ba9d98b3ecc3b6decf4392a651dcbfb (patch) | |
| tree | 5780ba9db2ad2249e4f2a401bc96952181a7c3a4 /doc/lispref | |
| parent | 41a20de9f4bc77586ed2e7cb4c21cb7f89baaea8 (diff) | |
| download | emacs-bc7d7ea63ba9d98b3ecc3b6decf4392a651dcbfb.tar.gz emacs-bc7d7ea63ba9d98b3ecc3b6decf4392a651dcbfb.zip | |
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')
| -rw-r--r-- | doc/lispref/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/lispref/modes.texi | 12 |
2 files changed, 13 insertions, 3 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 9379301ea4a..399c07d13f5 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | 2010-08-22 Chong Yidong <cyd@stupidchicken.com> | ||
| 2 | |||
| 3 | * modes.texi (Defining Minor Modes): Doc fix (Bug#6880). | ||
| 4 | |||
| 1 | 2010-08-19 Chong Yidong <cyd@stupidchicken.com> | 5 | 2010-08-19 Chong Yidong <cyd@stupidchicken.com> |
| 2 | 6 | ||
| 3 | * objects.texi (Bool-Vector Type): Minor definition tweak (Bug#6878). | 7 | * objects.texi (Bool-Vector Type): Minor definition tweak (Bug#6878). |
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 3953da59b93..12f16b67663 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 | |||
| 1411 | when the mode is enabled; if it is @code{nil}, the mode is not displayed | 1411 | when the mode is enabled; if it is @code{nil}, the mode is not displayed |
| 1412 | in the mode line. | 1412 | in the mode line. |
| 1413 | 1413 | ||
| 1414 | The optional argument @var{keymap} specifies the keymap for the minor mode. | 1414 | The optional argument @var{keymap} specifies the keymap for the minor |
| 1415 | It can be a variable name, whose value is the keymap, or it can be an alist | 1415 | mode. If non-@code{nil}, it should be a variable name (whose value is |
| 1416 | specifying bindings in this form: | 1416 | a keymap), a keymap, or an alist of the form |
| 1417 | 1417 | ||
| 1418 | @example | 1418 | @example |
| 1419 | (@var{key-sequence} . @var{definition}) | 1419 | (@var{key-sequence} . @var{definition}) |
| 1420 | @end example | 1420 | @end example |
| 1421 | 1421 | ||
| 1422 | @noindent | ||
| 1423 | where each @var{key-sequence} and @var{definition} are arguments | ||
| 1424 | suitable for passing to @code{define-key} (@pxref{Changing Key | ||
| 1425 | Bindings}). If @var{keymap} is a keymap or an alist, this also | ||
| 1426 | defines the variable @code{@var{mode}-map}. | ||
| 1427 | |||
| 1422 | The above three arguments @var{init-value}, @var{lighter}, and | 1428 | The above three arguments @var{init-value}, @var{lighter}, and |
| 1423 | @var{keymap} can be (partially) omitted when @var{keyword-args} are | 1429 | @var{keymap} can be (partially) omitted when @var{keyword-args} are |
| 1424 | used. The @var{keyword-args} consist of keywords followed by | 1430 | used. The @var{keyword-args} consist of keywords followed by |