On 25 October 2016 at 23:45, Dmitry Gutov <dgutov@yandex.ru> wrote:

> On 25.10.2016 21:44, Reuben Thomas wrote:
>
> I should check some context: my understanding is that inline
>> documentation in .el files is mainly useful for high-level documentation
>> for standalone packages. Packages that form part of Emacs should be
>> documented in the manual (as whitespace.el is); details of functions and
>> variables should be in docstrings (as is the case for whitespace.el).
>> The docstrings of customizable options are readable in the customize
>> interface.
>>
>
> Maybe you're right. I'd leave at least "to change behavior, do M-x
> customize-group whitespace", though.


​I've re-added that.​

​
> You can automate the adherence to most of these rules by first entering
> the messages in a local-only ChangeLog file, using 'C-x 4 a'. Also see
> "Generating ChangeLog entries" in CONTRIBUTE.


​Thanks, I was confused by the fact that since I last submitted patches, we
no longer update ChangeLog files directly when committing.

Thanks. Do you have commit access?
>

​I have.​

I attach the patch series again with the documentation fix above, and two
more patches which complete my intended work. The last two are:

1. Fix documentation to mention `tab-width', not `8'.

2. Fix whitespace-report-region to a) use the currently active
whitespace-style, that is, whitespace-style-active, and b) take a copy of
it, so that use of the `force' parameter does not cause the style to be
updated outside the function. It falls back to `whitespace-style' if
`whitespace-active-style' is not set, so that whitespace-report can be used
when the mode is not already active (I use it thus to turn the mode on only
in whitespace-clean buffers in my whitespace-enable-predicate).

-- 
http://rrt.sc3d.org