diff options
author | John Shahid <jvshahid@gmail.com> | 2018-07-01 23:34:53 -0400 |
---|---|---|
committer | Stefan Monnier <monnier@iro.umontreal.ca> | 2018-07-01 23:34:53 -0400 |
commit | ee3e432300054ca488896e39fca57b10d733330a (patch) | |
tree | 3ba92bb1967b9c2047931cc43175641fa8a1e05c /lisp/net | |
parent | fd5bf49139ab84f630b60c6714e0db2da34edff2 (diff) | |
download | emacs-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/net')
-rw-r--r-- | lisp/net/goto-addr.el | 5 | ||||
-rw-r--r-- | lisp/net/rcirc.el | 13 |
2 files changed, 3 insertions, 15 deletions
diff --git a/lisp/net/goto-addr.el b/lisp/net/goto-addr.el index cc1cdd15184..db59df374b1 100644 --- a/lisp/net/goto-addr.el +++ b/lisp/net/goto-addr.el @@ -270,10 +270,7 @@ Also fontifies the buffer appropriately (see `goto-address-fontify-p' and ;;;###autoload (define-minor-mode goto-address-mode - "Minor mode to buttonize URLs and e-mail addresses in the current buffer. -With a prefix argument ARG, enable the mode if ARG is positive, -and disable it otherwise. If called from Lisp, enable the mode -if ARG is omitted or nil." + "Minor mode to buttonize URLs and e-mail addresses in the current buffer." nil "" nil diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el index abd969216f3..5b63e0c34df 100644 --- a/lisp/net/rcirc.el +++ b/lisp/net/rcirc.el @@ -186,9 +186,6 @@ underneath each nick." (define-minor-mode rcirc-omit-mode "Toggle the hiding of \"uninteresting\" lines. -With a prefix argument ARG, enable Rcirc-Omit mode if ARG is -positive, and disable it otherwise. If called from Lisp, enable -the mode if ARG is omitted or nil. Uninteresting lines are those whose responses are listed in `rcirc-omit-responses'." @@ -1353,10 +1350,7 @@ Create the buffer if it doesn't exist." "Keymap for multiline mode in rcirc.") (define-minor-mode rcirc-multiline-minor-mode - "Minor mode for editing multiple lines in rcirc. -With a prefix argument ARG, enable the mode if ARG is positive, -and disable it otherwise. If called from Lisp, enable the mode -if ARG is omitted or nil." + "Minor mode for editing multiple lines in rcirc." :init-value nil :lighter " rcirc-mline" :keymap rcirc-multiline-minor-mode-map @@ -1867,10 +1861,7 @@ This function does not alter the INPUT string." ;;;###autoload (define-minor-mode rcirc-track-minor-mode - "Global minor mode for tracking activity in rcirc buffers. -With a prefix argument ARG, enable the mode if ARG is positive, -and disable it otherwise. If called from Lisp, enable the mode -if ARG is omitted or nil." + "Global minor mode for tracking activity in rcirc buffers." :init-value nil :lighter "" :keymap rcirc-track-minor-mode-map |