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 commit is contained in:
parent
e95d0d15bb
commit
3462fe7335
1 changed files with 16 additions and 8 deletions
|
@ -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
|
||||
|
|
Loading…
Add table
Reference in a new issue