summaryrefslogtreecommitdiff
path: root/lisp/vcursor.el
diff options
context:
space:
mode:
authorJohn Shahid <jvshahid@gmail.com>2018-07-01 23:34:53 -0400
committerStefan Monnier <monnier@iro.umontreal.ca>2018-07-01 23:34:53 -0400
commitee3e432300054ca488896e39fca57b10d733330a (patch)
tree3ba92bb1967b9c2047931cc43175641fa8a1e05c /lisp/vcursor.el
parentfd5bf49139ab84f630b60c6714e0db2da34edff2 (diff)
downloademacs-ee3e432300054ca488896e39fca57b10d733330a.tar.gz
Optionally add argument description in minor mode DOC (bug#10754)
Add a paragraph to minor mode's docstring documenting the mode's ARG usage if the supplied docstring doesn't already contain the word "ARG". * easy-mmode.el (easy-mmode--arg-docstring): New const. (easy-mmode--arg-docstring): New function. (define-minor-mode): Use them. Remove argument documentation from all minor modes.
Diffstat (limited to 'lisp/vcursor.el')
-rw-r--r--lisp/vcursor.el3
1 files changed, 1 insertions, 2 deletions
diff --git a/lisp/vcursor.el b/lisp/vcursor.el
index 89743304526..ce7a895a62c 100644
--- a/lisp/vcursor.el
+++ b/lisp/vcursor.el
@@ -815,8 +815,7 @@ out how much to copy."
(define-minor-mode vcursor-use-vcursor-map
"Toggle the state of the vcursor key map.
-With a prefix argument ARG, enable it if ARG is positive, and disable
-it otherwise. If called from Lisp, enable it if ARG is omitted or nil.
+
When on, the keys defined in it are mapped directly on top of the main
keymap, allowing you to move the vcursor with ordinary motion keys.
An indication \"!VC\" appears in the mode list. The effect is