Re: [PATCH v2] t/README: unify documentation of test function args

From: Junio C Hamano <gitster@pobox.com>
Date: Apr 27, 2011, 04:44 UTC
Message-ID: <7vei4ob8w9.fsf@alter.siamese.dyndns.org>
In-Reply-To: <1303839041.18603.17.camel@drew-northup.unet.maine.edu>

Drew Northup <drew.northup@maine.edu> writes:

Show 14 quoted lines

> On Tue, 2011-04-26 at 12:33 +0200, Mathias Lafeldt wrote:
>
>> @@ -389,7 +389,7 @@ library for your script to use.
>>  	    'git-write-tree should be able to write an empty tree.' \
>>  	    'tree=$(git-write-tree)'
>>  
>> -   If you supply three parameters the first will be taken to be a
>> +   If you supply three parameters, the first will be taken to be a
>>     prerequisite, see the test_set_prereq and test_have_prereq
>>     documentation below:
>
> As "If you supply three parameters" is not an introductory clause to a
> larger complete thought in the following few words, the additional comma
> is unnecessary.

Makes sense.

On the other hand, "see the ... below" is a separate sentence, and it deserves to have something stronger than a comma in front of it. I've queued with a minor fixup.

Thanks.