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

> ​​
>
> A few comments on the patches themselves:
>

​Thanks very much for the review.​

- "remove duplicate documentation from the Commentary" sounds fine to me,
> but maybe we should leave something in its stead. The first part can be
> replaced with a reference to the `whitespace-style' docstring. The second
> one... is it really that out of date? The list of variables seems like it
> can be useful.
>

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.

I have updated my patch to provide a cross-reference to the documentation
for whitespace-style, as you suggest. The other section of documentation
that I removed is for customizable options, which are fully documented in
the defcustom docstrings. (I have now checked this exhaustively.)


> - The commit messages don't follow the ChangeLog format, see
> https://www.gnu.org/prep/standards/html_node/Change-Logs.html, or simply
> the existing commit messages.
>

​Apologies. As far as I could see, the main things that were wrong were the
summary lines and the lack of function names (or equivalent) in the
detailed log. I have rewritten all of them.

I have rebased the patch series against master and attach the new version.

-- 
http://rrt.sc3d.org