[darcs-devel] [patch2043] improve help texts and how they are generated

[Ganesh Sittampalam]

Ganesh Sittampalam <ganesh at earth.li> added the comment:

Partial review:

On 07/07/2020 11:26, Ben Franksen wrote:

> The patches
> 
>   * remove initial blurb from the manpage
> 
> and
> 
>   * extend the description in the manpage
> 
> should be regarded as a unit: the second replaces the blurb with (IMHO) more
> useful conceptual information.

Agreed.

>   * generate the manpage as a Doc, rather than [String]

Fine.


>   * remove an obsolete comment in D.UI.Commands.Help
>   
>   The ".br" directive is not listed as an extension by man 7 groff_diff.

Fine.

>   * extend the description in the manpage

Fine.

>   * retype commandHelp from String to Doc

Fine.

>   * fix docs for D.UI.Commands.Help.manpage

Fine.

>   * streamline module haddocks for Darcs.Util.Printer
>   
>   Most of the deleted text was completely outdated information.

OK. I don't think I ever read it :-)

>   * remove module Darcs.Util.Text

OK

>   * improve support for autoformatting help texts

OK

>   * autoformat help for clone, push, pull, and send
>   * autoformat help for record
>   * autoformat help for history editing commands
>   * autoformat help for log
>   * autoformat help for apply

OK - I haven't read through all the changes in detail.

__________________________________
Darcs bug tracker <bugs at darcs.net>
<http://bugs.darcs.net/patch2043>
__________________________________