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/electric.el | |
parent | fd5bf49139ab84f630b60c6714e0db2da34edff2 (diff) | |
download | emacs-ee3e432300054ca488896e39fca57b10d733330a.tar.gz emacs-ee3e432300054ca488896e39fca57b10d733330a.tar.bz2 emacs-ee3e432300054ca488896e39fca57b10d733330a.zip |
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/electric.el')
-rw-r--r-- | lisp/electric.el | 10 |
1 files changed, 1 insertions, 9 deletions
diff --git a/lisp/electric.el b/lisp/electric.el index a45faf2dbb5..8730b0752c8 100644 --- a/lisp/electric.el +++ b/lisp/electric.el @@ -325,9 +325,6 @@ column specified by the function `current-left-margin'." ;;;###autoload (define-minor-mode electric-indent-mode "Toggle on-the-fly reindentation (Electric Indent mode). -With a prefix argument ARG, enable Electric Indent mode if ARG is -positive, and disable it otherwise. If called from Lisp, enable -the mode if ARG is omitted or nil. When enabled, this reindents whenever the hook `electric-indent-functions' returns non-nil, or if you insert a character from `electric-indent-chars'. @@ -411,9 +408,7 @@ newline after CHAR but stay in the same place.") ;;;###autoload (define-minor-mode electric-layout-mode "Automatically insert newlines around some chars. -With a prefix argument ARG, enable Electric Layout mode if ARG is -positive, and disable it otherwise. If called from Lisp, enable -the mode if ARG is omitted or nil. + The variable `electric-layout-rules' says when and how to insert newlines." :global t :group 'electricity (cond (electric-layout-mode @@ -551,9 +546,6 @@ This requotes when a quoting key is typed." ;;;###autoload (define-minor-mode electric-quote-mode "Toggle on-the-fly requoting (Electric Quote mode). -With a prefix argument ARG, enable Electric Quote mode if -ARG is positive, and disable it otherwise. If called from Lisp, -enable the mode if ARG is omitted or nil. When enabled, as you type this replaces \\=` with ‘, \\=' with ’, \\=`\\=` with “, and \\='\\=' with ”. This occurs only in comments, strings, |