diff mbox series

Fix grammar in git push man page

Message ID 20230810004044.1420385-1-wesleys@opperschaap.net (mailing list archive)
State New, archived
Headers show
Series Fix grammar in git push man page | expand

Commit Message

Wesley Schwengle Aug. 10, 2023, 12:40 a.m. UTC
While working on a blog post and using grammarly it suggested these two
changes.

Signed-off-by: Wesley Schwengle <wesleys@opperschaap.net>
---
 Documentation/git-push.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Junio C Hamano Aug. 10, 2023, 1:13 a.m. UTC | #1
Wesley Schwengle <wesleys@opperschaap.net> writes:

> Subject: Re: [PATCH] Fix grammar in git push man page

We would probably phrase it more like

	Subject: git-push.txt: fix grammar

> While working on a blog post and using grammarly it suggested these two
> changes.
>
> Signed-off-by: Wesley Schwengle <wesleys@opperschaap.net>
> ---
>  Documentation/git-push.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
> index 297927d866..6926e79719 100644
> --- a/Documentation/git-push.txt
> +++ b/Documentation/git-push.txt
> @@ -37,7 +37,7 @@ the default `<refspec>` by consulting `remote.*.push` configuration,
>  and if it is not found, honors `push.default` configuration to decide
>  what to push (See linkgit:git-config[1] for the meaning of `push.default`).
>  
> -When neither the command-line nor the configuration specify what to
> +When neither the command line nor the configuration specifies what to

The fix for the verb is very much correct and appreciated.

The first part is debatable for two reasons.

Locally, what is "fixed" is only one of the two instances of
"command-line" in this file.  If we were to clean it up, you would
at least want to do the other one for consistency.

Globally, git grep -i "command.line" in Documentation (excluding
Documentation/RelNotes, as that part is almost exclusively written
by me and shows my bias) gives ~200 hits for "command line" and ~100
hits for "command-line".  We pretty much use them inter-changeably,
in other words.

But for the grammar fix, it probably makes sense to just fix the
verb without touching "command-line"; you have ~100 other instances
that want to be touched for consistency, and they shouldn't take the
verb fix hostage.

Thanks.

>  push, the default behavior is used, which corresponds to the `simple`
>  value for `push.default`: the current branch is pushed to the
>  corresponding upstream branch, but as a safety measure, the push is
Bagas Sanjaya Aug. 10, 2023, 1:41 a.m. UTC | #2
On Wed, Aug 09, 2023 at 08:40:25PM -0400, Wesley Schwengle wrote:
> -When neither the command-line nor the configuration specify what to
> +When neither the command line nor the configuration specifies what to

IMO either command-line or command line is correct...
Bagas Sanjaya Aug. 10, 2023, 1:45 a.m. UTC | #3
On 10/08/2023 08:41, Bagas Sanjaya wrote:
> On Wed, Aug 09, 2023 at 08:40:25PM -0400, Wesley Schwengle wrote:
>> -When neither the command-line nor the configuration specify what to
>> +When neither the command line nor the configuration specifies what to
> 
> IMO either command-line or command line is correct...
> 

Oops, I mean both forms (with and without dash) are correct.
diff mbox series

Patch

diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index 297927d866..6926e79719 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -37,7 +37,7 @@  the default `<refspec>` by consulting `remote.*.push` configuration,
 and if it is not found, honors `push.default` configuration to decide
 what to push (See linkgit:git-config[1] for the meaning of `push.default`).
 
-When neither the command-line nor the configuration specify what to
+When neither the command line nor the configuration specifies what to
 push, the default behavior is used, which corresponds to the `simple`
 value for `push.default`: the current branch is pushed to the
 corresponding upstream branch, but as a safety measure, the push is