Skip to content

Commit 4ad1a11

Browse files
yilinweieshrh
authored andcommitted
fix documentation for meow-define-state
The documentation was `meow-define-state` wrongly specified that the macro supported the `:form` keyword. Correct the documentation.
1 parent d180d47 commit 4ad1a11

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

meow-helpers.el

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -187,15 +187,17 @@ Recognized keywords:
187187
:keymap - the keymap to use for the state
188188
:lighter - the text to display in the mode line while state is active
189189
:face - custom cursor face
190-
:form - one lisp form that will be run when the minor mode turns on AND off.
191-
If you want to hook into only the turn-on event, check whether
192-
(meow-NAME-SYM-mode) is true.
190+
191+
The last argument is an optional lisp form that will be run when the minor
192+
mode turns on AND off. If you want to hook into only the turn-on event,
193+
check whether (meow-NAME-SYM-mode) is true.
193194
194195
Example usage:
195196
(meow-define-state mystate
196197
\"My meow state\"
197198
:lighter \" [M]\"
198-
:keymap 'my-keymap)
199+
:keymap 'my-keymap
200+
(message \"toggled state\"))
199201
200202
Also see meow-register-state, which is used internally by this
201203
function, if you want more control over defining your state. This

0 commit comments

Comments
 (0)