Ramkumar Ramachandra <artag...@gmail.com> writes:

> Junio C Hamano wrote:
>> Ramkumar Ramachandra <artag...@gmail.com> writes:
>>> Under the EXAMPLES section, there is one invocation on the git.git
>>> repository that attempts to list the refs master, pu, and rc.  The ref
>>> rc does not exist in today's repository, so remove it.  Among other
>>> things, this example demonstrates that the "<refs>..." argument is
>>> simply a filter; requesting a non-existent ref is not an error.
>> These last two lines are better be in the documentation, no?
> You're no happy with the existing documentation?

I am not so happy with the existing EXAMPLE.  Lazy people (myself
included when trying to figure out other people's software) jump
straight to the EXAMPLES section without reading the main body.

Especially for these people, it makes tons of difference if a sample
command is accompanied by an explanation of key points the example
tries to illustrate.  In this particular manual page, there are a
couple of commands and its sample output listed but nothing else.
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Reply via email to