Re: [PATCH] Grammar fixes for gitattributes documentation

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 14, 2007, 08:55 UTC
Message-ID: <7vfxz9kxz3.fsf@gitster.siamese.dyndns.org>
In-Reply-To: <33080F0B-80C0-4860-9A74-C6878EE3B2CD@wincent.com>

Wincent Colaiuta <win@wincent.com> writes:

Show 5 quoted lines

> Tweak the "filter" section of the gitattributes documentation to add
> some missing articles and improve some word choices without changing
> the semantics of the section.
>
> Signed-off-by: Wincent Colaiuta <win@wincent.com>

Thanks.

Show 12 quoted lines

> diff --git a/Documentation/gitattributes.txt b/Documentation/
> gitattributes.txt
> index 20cf8ff..b01786b 100644
> --- a/Documentation/gitattributes.txt
> +++ b/Documentation/gitattributes.txt
> @@ -148,22 +148,23 @@ with `$Id$` upon check-in.
>  `filter`
>  ^^^^^^^^
>
> -A `filter` attribute can be set to a string value.  This names
> +A `filter` attribute can be set to a string value which names a
>  filter driver specified in the configuration.

Will we get the canned "which vs that" discussion on this change?

Show 11 quoted lines

> -A filter driver consists of `clean` command and `smudge`
> +A filter driver consists of a `clean` command and a `smudge`
>  command, either of which can be left unspecified.  Upon
> -checkout, when `smudge` command is specified, the command is fed
> +checkout, when the `smudge` command is specified, the command is fed
> -the blob object from its standard input, and its standard output
> +the blob object from its standard input, and its standard output
> -is used to update the worktree file.  Similarly, `clean` command
> +is used to update the worktree file.  Similarly, the `clean` command
> -is used to convert the contents of worktree file upon checkin.
> +is used to convert the contents of worktree file upon checkin.

I do appreciate the grammar fixes, but I needed to re-wrap and swap lines to see the real change. Especially, after this re-wrapping, the updated lines with missing "the" fixed still fit nicely below 70 columns and the right edge is not too ragged to be distractive even for people who read unformatted text.

Could you please avoid this kind of unnecessary re-wrapping in the future patches?