diff options
author | Chong Yidong <cyd@gnu.org> | 2011-10-19 08:54:24 -0400 |
---|---|---|
committer | Chong Yidong <cyd@gnu.org> | 2011-10-19 08:54:24 -0400 |
commit | 06e21633a4a9de1e8013376cf92d912817df28cd (patch) | |
tree | 82b50a4f717e0836ae06ea529a4c873282c74ebc /lisp/whitespace.el | |
parent | 12b32963196147a21ac0945396d24ab67e4a221a (diff) | |
download | emacs-06e21633a4a9de1e8013376cf92d912817df28cd.tar.gz |
Fix minor mode docstrings for the new meaning of a nil ARG.
* abbrev.el (abbrev-mode):
* allout.el (allout-mode):
* autoinsert.el (auto-insert-mode):
* autoarg.el (autoarg-mode, autoarg-kp-mode):
* autorevert.el (auto-revert-mode, auto-revert-tail-mode)
(global-auto-revert-mode):
* battery.el (display-battery-mode):
* composite.el (global-auto-composition-mode)
(auto-composition-mode):
* delsel.el (delete-selection-mode):
* desktop.el (desktop-save-mode):
* dired-x.el (dired-omit-mode):
* dirtrack.el (dirtrack-mode):
* doc-view.el (doc-view-minor-mode):
* double.el (double-mode):
* electric.el (electric-indent-mode, electric-pair-mode):
* emacs-lock.el (emacs-lock-mode):
* epa-hook.el (auto-encryption-mode):
* follow.el (follow-mode):
* font-core.el (font-lock-mode):
* frame.el (auto-raise-mode, auto-lower-mode, blink-cursor-mode):
* help.el (temp-buffer-resize-mode):
* hilit-chg.el (highlight-changes-mode)
(highlight-changes-visible-mode):
* hi-lock.el (hi-lock-mode):
* hl-line.el (hl-line-mode, global-hl-line-mode):
* icomplete.el (icomplete-mode):
* ido.el (ido-everywhere):
* image-file.el (auto-image-file-mode):
* image-mode.el (image-minor-mode):
* iswitchb.el (iswitchb-mode):
* jka-cmpr-hook.el (auto-compression-mode):
* linum.el (linum-mode):
* longlines.el (longlines-mode):
* master.el (master-mode):
* mb-depth.el (minibuffer-depth-indicate-mode):
* menu-bar.el (menu-bar-mode):
* minibuf-eldef.el (minibuffer-electric-default-mode):
* mouse-sel.el (mouse-sel-mode):
* msb.el (msb-mode):
* mwheel.el (mouse-wheel-mode):
* outline.el (outline-minor-mode):
* paren.el (show-paren-mode):
* recentf.el (recentf-mode):
* reveal.el (reveal-mode, global-reveal-mode):
* rfn-eshadow.el (file-name-shadow-mode):
* ruler-mode.el (ruler-mode):
* savehist.el (savehist-mode):
* scroll-all.el (scroll-all-mode):
* scroll-bar.el (scroll-bar-mode):
* server.el (server-mode):
* shell.el (shell-dirtrack-mode):
* simple.el (auto-fill-mode, transient-mark-mode)
(visual-line-mode, overwrite-mode, binary-overwrite-mode)
(line-number-mode, column-number-mode, size-indication-mode)
(auto-save-mode, normal-erase-is-backspace-mode, visible-mode):
* strokes.el (strokes-mode):
* time.el (display-time-mode):
* t-mouse.el (gpm-mouse-mode):
* tool-bar.el (tool-bar-mode):
* tooltip.el (tooltip-mode):
* type-break.el (type-break-mode-line-message-mode)
(type-break-query-mode):
* view.el (view-mode):
* whitespace.el (whitespace-mode, whitespace-newline-mode)
(global-whitespace-mode, global-whitespace-newline-mode):
* xt-mouse.el (xterm-mouse-mode): Doc fix.
* emacs-lisp/easy-mmode.el (define-globalized-minor-mode): Fix
autogenerated docstring.
Diffstat (limited to 'lisp/whitespace.el')
-rw-r--r-- | lisp/whitespace.el | 36 |
1 files changed, 16 insertions, 20 deletions
diff --git a/lisp/whitespace.el b/lisp/whitespace.el index e0bc74343d2..8dc1996734d 100644 --- a/lisp/whitespace.el +++ b/lisp/whitespace.el @@ -1064,11 +1064,10 @@ Any other value is treated as nil." ;;;###autoload (define-minor-mode whitespace-mode - "Toggle whitespace minor mode visualization (\"ws\" on modeline). - -If ARG is null, toggle whitespace visualization. -If ARG is a number greater than zero, turn on visualization; -otherwise, turn off visualization. + "Toggle whitespace visualization (Whitespace mode). +With a prefix argument ARG, enable Whitespace mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. See also `whitespace-style', `whitespace-newline' and `whitespace-display-mappings'." @@ -1088,11 +1087,10 @@ See also `whitespace-style', `whitespace-newline' and ;;;###autoload (define-minor-mode whitespace-newline-mode - "Toggle NEWLINE minor mode visualization (\"nl\" on modeline). - -If ARG is null, toggle NEWLINE visualization. -If ARG is a number greater than zero, turn on visualization; -otherwise, turn off visualization. + "Toggle newline visualization (Whitespace Newline mode). +With a prefix argument ARG, enable Whitespace Newline mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. Use `whitespace-newline-mode' only for NEWLINE visualization exclusively. For other visualizations, including NEWLINE @@ -1116,11 +1114,10 @@ See also `whitespace-newline' and `whitespace-display-mappings'." ;;;###autoload (define-minor-mode global-whitespace-mode - "Toggle whitespace global minor mode visualization (\"WS\" on modeline). - -If ARG is null, toggle whitespace visualization. -If ARG is a number greater than zero, turn on visualization; -otherwise, turn off visualization. + "Toggle whitespace visualization globally (Global Whitespace mode). +With a prefix argument ARG, enable Global Whitespace mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable it if ARG is omitted or nil. See also `whitespace-style', `whitespace-newline' and `whitespace-display-mappings'." @@ -1174,11 +1171,10 @@ See also `whitespace-style', `whitespace-newline' and ;;;###autoload (define-minor-mode global-whitespace-newline-mode - "Toggle NEWLINE global minor mode visualization (\"NL\" on modeline). - -If ARG is null, toggle NEWLINE visualization. -If ARG is a number greater than zero, turn on visualization; -otherwise, turn off visualization. + "Toggle global newline visualization (Global Whitespace Newline mode). +With a prefix argument ARG, enable Global Whitespace Newline mode +if ARG is positive, and disable it otherwise. If called from +Lisp, enable it if ARG is omitted or nil. Use `global-whitespace-newline-mode' only for NEWLINE visualization exclusively. For other visualizations, including |