bug#18296: 24.4.50; doc string of `whitespace-mode'

[Lars Ingebrigtsen]

Drew Adams <drew.adams@oracle.com> writes:

> 1. Please mention which faces are used for which kinds of highlighting.

Well, there's a lot of faces, and I think it's unusual for modes like
this to enumerate them.  But perhaps a link to the customisation group
would be nice?  Is there a syntax for that?

> 2. Wording:
>
>  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.
>
> A minimal fix:
>
>  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'.

Installed.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no