Re: [PATCH 01/11] doc: trailer: fix grammar
From: Linus Arver <hidden>
Date: 2023-05-08 19:33:31
Junio C Hamano [off-list ref] writes:
"Linus Arver via GitGitGadget" [off-list ref] writes:
quoted
From: Linus Arver <redacted>
quoted
Signed-off-by: Linus Arver <redacted> --- Documentation/git-interpret-trailers.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
quoted
diff --git a/Documentation/git-interpret-trailers.txtb/Documentation/git-interpret-trailers.txt index 22ff3a603e0..e695977fbfa 100644--- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt@@ -14,7 +14,7 @@ SYNOPSIS
quoted
DESCRIPTION ----------- -Help parsing or adding 'trailers' lines, that look similar to RFC 822 e-mail +Parse or add 'trailer' lines, that look similar to RFC 822 e-mail headers, at the end of the otherwise free-form part of a commit message.
Is that a grammatically incorrect sentence?
I think so. If we remove the dependent clauses starting with "that look
similar ...", we just get
Help parsing or adding 'trailers' lines
which cannot stand on its own as an independent clause. The correct
version would be
Help parse or add 'trailers' lines
which is what I first considered. However the auxiliary verb "help" here
doesn't really mean much, because the interpret-trailers builtin already
is _the_ authority for parsing or adding trailer lines, so I opted to
remove it in my patch.
The command does help doing these two things, but we can say the command does these two things without closing clarity, so I do not have an objection to the updated text
Exactly (I think you meant s/closing/losing here).
(the only "ungrammatical" part may be that ", that look" should probably be "that look"), but I am not sure if "fix grammar" is a good explanation for this commit.
I think punctuation (especially with commas) can be pretty wide-ranging in terms of what is acceptable or not in terms of grammar. But looking at it again I like your version with the comma removed. I'll make the change locally for a v2 series.