Re: [PATCH v10 5/5] help: respect new common command grouping

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, May 21, 2015 at 12:16 PM, Junio C Hamano <gitster@xxxxxxxxx> wrote:
> Eric Sunshine <sunshine@xxxxxxxxxxxxxx> writes:
>>> +       puts(_("These are common Git commands used in various situations:"));
>>
>> The clause "in various situations" is quite nebulous and thus adds no
>> substance.
>
> FWIW I view the latter half of that sentence as explaining the group
> labels which we did not have (so we did not have to mention in the
> original).

Hmm, but is it necessary to explain the group labels in the first
place? The help output (group labels and all) seems self-explanatory
already, and one would expect (hope) that readers are intelligent
enough to understand implicitly that the group labels are a simple
organizational aid. If that understanding is indeed implicit, then
there should be no need to declare it explicitly and "in various
situations" becomes mere noise.

> Perhaps swapping the order may clarify, as the list
> itself is a two-level, i.e. list of workflow elements, each of which
> has list of commands?

Perhaps, but I may not be the best judge of that since, to me, that
level of hand-holding seems unnecessary.

Anyhow, it's just a minor observation, and it's something people can
argue later if they feel strongly about it, so I don't think it should
hold up this patch series.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]