summaryrefslogtreecommitdiff
path: root/lisp/reveal.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/reveal.el
parentfd5bf49139ab84f630b60c6714e0db2da34edff2 (diff)
downloademacs-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/reveal.el')
-rw-r--r--lisp/reveal.el9
1 files changed, 1 insertions, 8 deletions
diff --git a/lisp/reveal.el b/lisp/reveal.el
index 2831c0cc010..a3ecfc490e0 100644
--- a/lisp/reveal.el
+++ b/lisp/reveal.el
@@ -191,9 +191,6 @@ Each element has the form (WINDOW . OVERLAY).")
;;;###autoload
(define-minor-mode reveal-mode
"Toggle uncloaking of invisible text near point (Reveal mode).
-With a prefix argument ARG, enable Reveal mode if ARG is
-positive, and disable it otherwise. If called from Lisp, enable
-Reveal mode if ARG is omitted or nil.
Reveal mode is a buffer-local minor mode. When enabled, it
reveals invisible text around point."
@@ -210,11 +207,7 @@ reveals invisible text around point."
;;;###autoload
(define-minor-mode global-reveal-mode
"Toggle Reveal mode in all buffers (Global Reveal mode).
-Reveal mode renders invisible text around point visible again.
-
-With a prefix argument ARG, enable Global Reveal mode if ARG is
-positive, and disable it otherwise. If called from Lisp, enable
-the mode if ARG is omitted or nil."
+Reveal mode renders invisible text around point visible again."
:global t :group 'reveal
(setq-default reveal-mode global-reveal-mode)
(if global-reveal-mode