summaryrefslogtreecommitdiff
path: root/lisp/ruler-mode.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/ruler-mode.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/ruler-mode.el')
-rw-r--r--lisp/ruler-mode.el5
1 files changed, 1 insertions, 4 deletions
diff --git a/lisp/ruler-mode.el b/lisp/ruler-mode.el
index 02d5a211ba7..366bd150413 100644
--- a/lisp/ruler-mode.el
+++ b/lisp/ruler-mode.el
@@ -591,10 +591,7 @@ format first."
;;;###autoload
(define-minor-mode ruler-mode
- "Toggle display of ruler in header line (Ruler mode).
-With a prefix argument ARG, enable Ruler mode if ARG is positive,
-and disable it otherwise. If called from Lisp, enable the mode
-if ARG is omitted or nil."
+ "Toggle display of ruler in header line (Ruler mode)."
nil nil
ruler-mode-map
:group 'ruler-mode