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/files.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/files.el')
-rw-r--r-- | lisp/files.el | 8 |
1 files changed, 2 insertions, 6 deletions
diff --git a/lisp/files.el b/lisp/files.el index 398e6dc12b8..31e2f39a8d1 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -419,14 +419,10 @@ idle for `auto-save-visited-interval' seconds." (define-minor-mode auto-save-visited-mode "Toggle automatic saving to file-visiting buffers on or off. -With a prefix argument ARG, enable regular saving of all buffers -visiting a file if ARG is positive, and disable it otherwise. + Unlike `auto-save-mode', this mode will auto-save buffer contents to the visited files directly and will also run all save-related -hooks. See Info node `Saving' for details of the save process. - -If called from Lisp, enable the mode if ARG is omitted or nil, -and toggle it if ARG is `toggle'." +hooks. See Info node `Saving' for details of the save process." :group 'auto-save :global t (when auto-save--timer (cancel-timer auto-save--timer)) |