]> code.delx.au - gnu-emacs/commitdiff
Clarify whitespace-style doc string
authorLars Ingebrigtsen <larsi@gnus.org>
Sat, 30 Apr 2016 13:27:09 +0000 (15:27 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sun, 1 May 2016 17:27:11 +0000 (19:27 +0200)
* lisp/whitespace.el (whitespace-style): Doc clarification
(bug#18296).

(cherry picked from commit d96c720d0cca7c9ffbb4c712ad315bb707d6625c)

lisp/whitespace.el

index 53bf363daa4ce4e1f3435808a0cadb6a03fceec5..af906bab38fda4d35cc838f2a7568e0a590d411e 100644 (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.
-
-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.
+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 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"