Re: [PATCH] Document patch syntax.

From: Yann Dirson <ydirson@altern.org>
Date: May 12, 2007, 14:38 UTC
Message-ID: <20070512143827.GE16903@nan92-1-81-57-214-146.fbx.proxad.net>
In-Reply-To: <20070512135644.GA28039@diana.vm.bytemark.co.uk>

On Sat, May 12, 2007 at 03:56:44PM +0200, Karl Hasselström wrote:

Show 6 quoted lines

> On 2007-05-12 14:07:04 +0200, Yann Dirson wrote:
> 
> > +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 ?

Show 5 quoted lines

> > +Patches in the current stack are just refered to by their name.  Some
> > +commands allow to specify a patch in another stack of the repository;
> 
> s/allow to/allow you to/. Or "allows one to", but I prefer the second
> person here.

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 ?

> s/a '@'/an '@'/; "'@'" begins with a vowel sound. :-)
> s/position/positions/.
> s/ie./i.e./.
> s/refering/referring/.

OK

> > +bottom-most patch).  Similarly ''//top.old'' and ''//bottom.old''
> 
> You use double quotes here, and single quotes above. What's the
> distinction?

Er... is "typo" a distinction ? :) Confusion induced by wiki markups, probably :(

> Yes, I'm too picky.

Not a problem, I tend to be quite picky too :)

Best regards,

-- 
Yann.