Ævar Arnfjörð Bjarmason [off-list ref] writes:
-This hook is invoked by 'git am' script. It takes a single
+This hook is invoked by 'git am'. It takes a single
Good, as it does not matter to the readers that "am" happens to be
implemented as a script.
parameter, the name of the file that holds the proposed commit
-log message. Exiting with non-zero status causes
-'git am' to abort before applying the patch.
+log message. Exiting with non-zero causes 'git am' to abort
+before applying the patch.
I am not sure why you dropped "status" from here. The result is
harder to grok, at least to me. Perhaps "with a non-zero status"?
The hook is allowed to edit the message file in place, and can
-be used to normalize the message into some project standard
-format (if the project has one). It can also be used to refuse
-the commit after inspecting the message file.
+be used to e.g. normalize the message into some project standard
+format. It can also be used to refuse the commit after inspecting
+the message file.
OK. Or we can even drop "e.g." and the result still reads perfectly
fine.
This hook is invoked by 'git commit', and can be bypassed
-with `--no-verify` option. It takes no parameter, and is
+with the `--no-verify` option. It takes no parameters, and is
invoked before obtaining the proposed commit log message and
-making a commit. Exiting with non-zero status from this script
-causes the 'git commit' to abort.
+making a commit. Exiting with a non-zero status from this script
+causes the 'git commit' command to abort before creating a commit.
Good. And you kept "status" here, which is doubly good.
On Mon, Apr 25, 2016 at 8:33 PM, Junio C Hamano [off-list ref] wrote:
Ævar Arnfjörð Bjarmason [off-list ref] writes:
quoted
-This hook is invoked by 'git am' script. It takes a single
+This hook is invoked by 'git am'. It takes a single
Good, as it does not matter to the readers that "am" happens to be
implemented as a script.
Yeah, no need to mention it being a script. But aside from that I was
mainly trying to fix grammar errors:
* Incorrect: "This is invoked by 'git am' script"
* Correct: "This is invoked by the 'git am' script"
* Correct: "This is invoked by a 'git am' script"
I.e. a few things in these docs were missing the definite/indefinite article.
quoted
parameter, the name of the file that holds the proposed commit
-log message. Exiting with non-zero status causes
-'git am' to abort before applying the patch.
+log message. Exiting with non-zero causes 'git am' to abort
+before applying the patch.
I am not sure why you dropped "status" from here. The result is
harder to grok, at least to me. Perhaps "with a non-zero status"?
I'm not 100% sure about this actually, but I thought:
* Incorrect: "Exiting with non-zero status"
* Correct: "Exiting with non-zero"
* Correct: "Exiting with a non-zero status".
I.e. the first one is missing an "a", I thought I'd just make it more
brief, but sure, I'll make it "a non-zero status".
quoted
The hook is allowed to edit the message file in place, and can
-be used to normalize the message into some project standard
-format (if the project has one). It can also be used to refuse
-the commit after inspecting the message file.
+be used to e.g. normalize the message into some project standard
+format. It can also be used to refuse the commit after inspecting
+the message file.
OK. Or we can even drop "e.g." and the result still reads perfectly
fine.
Done, and willdo too for the other occurrence.
quoted
This hook is invoked by 'git commit', and can be bypassed
-with `--no-verify` option. It takes no parameter, and is
+with the `--no-verify` option. It takes no parameters, and is
invoked before obtaining the proposed commit log message and
-making a commit. Exiting with non-zero status from this script
-causes the 'git commit' to abort.
+making a commit. Exiting with a non-zero status from this script
+causes the 'git commit' command to abort before creating a commit.
Good. And you kept "status" here, which is doubly good.