diff options
| author | Richard M. Stallman | 2003-07-07 20:49:02 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2003-07-07 20:49:02 +0000 |
| commit | 8cd4f01871b769a3c5f3e533c5aa7a1838b1006f (patch) | |
| tree | d6d92dbebe8b4b000ee5eed5dcf53cebd56e93f7 | |
| parent | 85d88ff5fd7f8ad961d4c52e782e057c95539c96 (diff) | |
| download | emacs-8cd4f01871b769a3c5f3e533c5aa7a1838b1006f.tar.gz emacs-8cd4f01871b769a3c5f3e533c5aa7a1838b1006f.zip | |
(Minor Mode Conventions): Specify only some kinds
of list values as args to minor modes.
| -rw-r--r-- | lispref/modes.texi | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/lispref/modes.texi b/lispref/modes.texi index 3443dfbc6ca..8870c8632bf 100644 --- a/lispref/modes.texi +++ b/lispref/modes.texi | |||
| @@ -864,11 +864,12 @@ Define a command whose name is the same as the mode variable. | |||
| 864 | Its job is to enable and disable the mode by setting the variable. | 864 | Its job is to enable and disable the mode by setting the variable. |
| 865 | 865 | ||
| 866 | The command should accept one optional argument. If the argument is | 866 | The command should accept one optional argument. If the argument is |
| 867 | @code{nil}, it should toggle the mode (turn it on if it is off, and off | 867 | @code{nil}, it should toggle the mode (turn it on if it is off, and |
| 868 | if it is on). Otherwise, it should turn the mode on if the argument is | 868 | off if it is on). It should turn the mode on if the argument is a |
| 869 | a positive integer, a symbol other than @code{nil} or @code{-}, or a | 869 | positive integer, the symbol @code{t}, or a list whose @sc{car} is one |
| 870 | list whose @sc{car} is such an integer or symbol; it should turn the | 870 | of those. It should turn the mode off if the argument is a negative |
| 871 | mode off otherwise. | 871 | integer or zero, the symbol @code{-}, or a list whose @sc{car} is one |
| 872 | of those. The meaning of other arguments is not specified. | ||
| 872 | 873 | ||
| 873 | Here is an example taken from the definition of @code{transient-mark-mode}. | 874 | Here is an example taken from the definition of @code{transient-mark-mode}. |
| 874 | It shows the use of @code{transient-mark-mode} as a variable that enables or | 875 | It shows the use of @code{transient-mark-mode} as a variable that enables or |