summaryrefslogtreecommitdiff
path: root/lisp/face-remap.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/face-remap.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/face-remap.el')
-rw-r--r--lisp/face-remap.el10
1 files changed, 3 insertions, 7 deletions
diff --git a/lisp/face-remap.el b/lisp/face-remap.el
index 476736773bf..c6a976deb00 100644
--- a/lisp/face-remap.el
+++ b/lisp/face-remap.el
@@ -229,9 +229,6 @@ Each positive or negative step scales the default face height by this amount."
(define-minor-mode text-scale-mode
"Minor mode for displaying buffer text in a larger/smaller font.
-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.
The amount of scaling is determined by the variable
`text-scale-mode-amount': one step scales the global default
@@ -387,10 +384,9 @@ plist, etc."
;;;###autoload
(define-minor-mode buffer-face-mode
"Minor mode for a buffer-specific default face.
-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. When enabled, the face specified by the
-variable `buffer-face-mode-face' is used to display the buffer text."
+
+When enabled, the face specified by the variable
+`buffer-face-mode-face' is used to display the buffer text."
:lighter " BufFace"
(when buffer-face-mode-remapping
(face-remap-remove-relative buffer-face-mode-remapping))