]> git.eshelyaron.com Git - emacs.git/commitdiff
(Minor Mode Conventions): Specify only some kinds
authorRichard M. Stallman <rms@gnu.org>
Mon, 7 Jul 2003 20:49:02 +0000 (20:49 +0000)
committerRichard M. Stallman <rms@gnu.org>
Mon, 7 Jul 2003 20:49:02 +0000 (20:49 +0000)
of list values as args to minor modes.

lispref/modes.texi

index 3443dfbc6ca95051dd20226b68ef473b65ed6b2b..8870c8632bf3cfe9caba29a2661f16945954365c 100644 (file)
@@ -864,11 +864,12 @@ Define a command whose name is the same as the mode variable.
 Its job is to enable and disable the mode by setting the variable.
 
 The command should accept one optional argument.  If the argument is
-@code{nil}, it should toggle the mode (turn it on if it is off, and off
-if it is on).  Otherwise, it should turn the mode on if the argument is
-a positive integer, a symbol other than @code{nil} or @code{-}, or a
-list whose @sc{car} is such an integer or symbol; it should turn the
-mode off otherwise.
+@code{nil}, it should toggle the mode (turn it on if it is off, and
+off if it is on).  It should turn the mode on if the argument is a
+positive integer, the symbol @code{t}, or a list whose @sc{car} is one
+of those.  It should turn the mode off if the argument is a negative
+integer or zero, the symbol @code{-}, or a list whose @sc{car} is one
+of those.  The meaning of other arguments is not specified.
 
 Here is an example taken from the definition of @code{transient-mark-mode}.
 It shows the use of @code{transient-mark-mode} as a variable that enables or