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/scroll-lock.el | |
| 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/scroll-lock.el')
| -rw-r--r-- | lisp/scroll-lock.el | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/lisp/scroll-lock.el b/lisp/scroll-lock.el index 2ce0f4578bf..123fbb2b37b 100644 --- a/lisp/scroll-lock.el +++ b/lisp/scroll-lock.el @@ -49,12 +49,11 @@ ;;;###autoload (define-minor-mode scroll-lock-mode "Buffer-local minor mode for pager-like scrolling. -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, keys that normally move -point by line or paragraph will scroll the buffer by the -respective amount of lines instead and point will be kept -vertically fixed relative to window boundaries during scrolling." + +When enabled, keys that normally move point by line or paragraph +will scroll the buffer by the respective amount of lines instead +and point will be kept vertically fixed relative to window +boundaries during scrolling." :lighter " ScrLck" :keymap scroll-lock-mode-map (if scroll-lock-mode |