diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2016-09-16 12:46:15 +0300 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2016-09-23 17:09:51 +0300 |
| commit | 3a9866e203dd263accfb8f9d0a12f5337eb4cff1 (patch) | |
| tree | 8e228b5eaf8d100619705e156bed747e671659dc /lisp/whitespace.el | |
| parent | 2e2469bbfeb6c1865012f34a180c9beda9e56862 (diff) | |
| download | emacs-3a9866e203dd263accfb8f9d0a12f5337eb4cff1.tar.gz | |
Improve doc strings in whitespace.el
* lisp/whitespace.el (whitespace-mode, whitespace-newline-mode)
(global-whitespace-mode, global-whitespace-newline-mode): Improve
the doc strings. (Bug#24413)
This was backported from master
(cherry picked from commit 3462fe73351f3da5bc3ebf8296ee44dd2e6b1dbc)
Diffstat (limited to 'lisp/whitespace.el')
| -rw-r--r-- | lisp/whitespace.el | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/lisp/whitespace.el b/lisp/whitespace.el index af906bab38f..0f6b8df03de 100644 --- a/lisp/whitespace.el +++ b/lisp/whitespace.el @@ -1031,8 +1031,10 @@ Any other value is treated as nil." (define-minor-mode whitespace-mode "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. +positive, and disable it otherwise. + +If called from Lisp, also enables the mode if ARG is omitted or nil, +and toggles it if ARG is `toggle'. See also `whitespace-style', `whitespace-newline' and `whitespace-display-mappings'." @@ -1054,8 +1056,10 @@ See also `whitespace-style', `whitespace-newline' and (define-minor-mode whitespace-newline-mode "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. +is positive, and disable it otherwise. + +If called from Lisp, also enables the mode if ARG is omitted or nil, +and toggles it if ARG is `toggle'. Use `whitespace-newline-mode' only for NEWLINE visualization exclusively. For other visualizations, including NEWLINE @@ -1082,8 +1086,10 @@ See also `whitespace-newline' and `whitespace-display-mappings'." (define-minor-mode global-whitespace-mode "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. +is positive, and disable it otherwise. + +If called from Lisp, also enables the mode if ARG is omitted or nil, +and toggles it if ARG is `toggle'. See also `whitespace-style', `whitespace-newline' and `whitespace-display-mappings'." @@ -1141,8 +1147,10 @@ This variable is normally modified via `add-function'.") (define-minor-mode global-whitespace-newline-mode "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. +if ARG is positive, and disable it otherwise. + +If called from Lisp, also enables the mode if ARG is omitted or nil, +and toggles it if ARG is `toggle'. Use `global-whitespace-newline-mode' only for NEWLINE visualization exclusively. For other visualizations, including |