Re: [PATCH] Document patch syntax.

From: Jeff King <peff@peff.net>
Date: May 13, 2007, 08:27 UTC
Message-ID: <20070513082710.GA12712@coredump.intra.peff.net>
In-Reply-To: <20070512143827.GE16903@nan92-1-81-57-214-146.fbx.proxad.net>

On Sat, May 12, 2007 at 04:38:27PM +0200, Yann Dirson wrote:

Show 5 quoted lines

> > > +Patches in the stack are identified with a short name, which must be
> > > +unique in the stack.
> > s/a short name/short names/, maybe.
> Hm, not sure how that would play with the end of the sentence - any
> native english speaker with an opinion ?

Karl's version is more correct (but your version might be used by many native speakers). The second half of the sentence is correct because 'must' conjugates the same for singular and plural use; however, it might be more clear to say "...short name, each of which must be unique in the stack."

Show 6 quoted lines

> No strong opinion here.  However, that makes me think we should
> probably use guideline for the docs - here comes the question of which
> convention to use when refering to the user.  Do we address her
> directly ("you"), indirectly ("the user", "her" - don't remember where
> the "female user" use comes from, but we could maybe follow this),
> even more indirectly ("one"), or any other way ?

Most of the git docs already use direct address (just grep for 'you' in Documentation). It's less formal, but it tends to read much more easily.

-Peff