Suboptimal documentation?

[Martin Geisler]

Alan Mackenzie <acm at muc.de> writes:

> Hello, Matt.
>
> On Mon, Nov 24, 2014 at 02:02:26PM -0600, Matt Mackall wrote:
>> On Mon, 2014-11-24 at 16:38 +0000, Alan Mackenzie wrote:
>
>> > hg help branch (and the corresponding bit in the man page) says:
>
>> >     With no argument, show the current branch name. With one
>> >     argument, set the working directory branch name (the branch will
>> >     not exist in the repository until the next commit). Standard
>> >     practice recommends that primary development take place on the
>> >     'default' branch.
>
>> > Although one can work through this to a meaning, it is surely more
>> > opaque than it need be.  hg branch _creates_ a branch; it does not
>> > rename the current branch (which is a possible interpretation of "set
>> > the working directory branch name").
>
>> > 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.
>
>> This is not a standard patch format.
>
> It is not a patch at all.  It is an idea, a suggestion, positive
> criticism.
>
> Are ideas, suggestions, and positive criticism welcome on this mailing
> list?

Yeah, this is just Matt's quirky way of telling you "nice work, please
submit this as a patch that we can discuss before merging it!" :-)

-- 
Martin Geisler

http://google.com/+MartinGeisler
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 818 bytes
Desc: not available
URL: <http://lists.mercurial-scm.org/pipermail/mercurial/attachments/20141126/078926a0/attachment.asc>