Suboptimal documentation?

Harvey Chapman hchapman-hg at 3gfp.com
Mon Nov 24 16:52:05 UTC 2014


On Nov 24, 2014, at 11:38 AM, Alan Mackenzie <acm at muc.de> wrote:
> 
> With one argument, set the working directory branch name (the branch
> will not exist in the repository until the next commit).

> How about the following replacement for the second sentence:
> 
>    With one argument, create a new branch with that name.  The branch
>    will exist in the repository after the next commit.

I like this better, but you should keep the second sentence inside parentheses since it only applies to the sentence preceding it.

The original wording is confusing because it exposes mercurial's internal workings to the user rather than describing the practical result.




More information about the Mercurial mailing list