1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-02-04 20:27:45 +00:00

Clarify whitespace-style doc string

* lisp/whitespace.el (whitespace-style): Doc clarification
(bug#18296).

(cherry picked from commit d96c720d0cca7c9ffbb4c712ad315bb707d6625c)
This commit is contained in:
Lars Ingebrigtsen 2016-04-30 15:27:09 +02:00
parent 651182d070
commit 7a03d55230

View File

@ -528,14 +528,14 @@ these values is:
2. space-before-tab::tab
3. space-before-tab::space
So, for example, if indentation and indentation::space are
included in `whitespace-style' list, the indentation value is
evaluated instead of indentation::space value.
For example, if `indentation' and `indentation::space' are
included in `whitespace-style', the `indentation' value is used
instead of the `indentation::space' value.
One reason for not visualize spaces via faces (if `face' is not
included in `whitespace-style') is to use exclusively for
cleaning up a buffer. See `whitespace-cleanup' and
`whitespace-cleanup-region' for documentation.
One reason to not use faces to visualize spaces (i.e., not
include `face' in `whitespace-style') is to use `whitespace-mode'
only for cleaning up a buffer. See `whitespace-cleanup' and
`whitespace-cleanup-region'.
See also `whitespace-display-mappings' for documentation."
:type '(set :tag "Kind of Blank"