threads / patch / 51820

patchdoc: small formatting fix

Subject: [PATCH 1/1] doc: small formatting fix

## tl;dr

9 messages between Sep 9, 2019 and Sep 12, 2019. Diffs are folded; open one to read it.

replies: 8people: 4as markdown or json

Cameron Steffen via GitGitGadget· Sep 9, 2019, 23:21 UTC · lore

[PATCH 0/1] doc: small formatting fix

Edit: I need permission to submit please
Cameron Steffen (1):
  doc: small formatting fix
 Documentation/pretty-formats.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
base-commit: 75b2f01a0f642b39b0f29b6218515df9b5eb798e
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-330%2Fcamsteffen%2Fpatch-1-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-330/camsteffen/patch-1-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/330
-- 
gitgitgadget
Cameron Steffen via GitGitGadget· Sep 9, 2019, 23:21 UTC · re: Cameron Steffen via GitGitGadget · lore
From: Cameron Steffen <cam.steffen94@gmail.com>
move an incorrectly placed backtick
Signed-off-by: Cameron Steffen <cam.steffen94@gmail.com>
---
 Documentation/pretty-formats.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/pretty-formats.txt +1 −1
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index 079598307a..b87e2e83e6 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -208,7 +208,7 @@ endif::git-rev-list[]
 '%GP':: show the fingerprint of the primary key whose subkey was used
 	to sign a signed commit
 '%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2
-	minutes ago`}; the format follows the rules described for the
+	minutes ago}`; the format follows the rules described for the
 	`-g` option. The portion before the `@` is the refname as
 	given on the command line (so `git log -g refs/heads/master`
 	would yield `refs/heads/master@{0}`).
-- 
gitgitgadget
Derrick Stolee· Sep 11, 2019, 11:50 UTC · re: Cameron Steffen via GitGitGadget · lore

Re: [PATCH 1/1] doc: small formatting fix

On 9/9/2019 7:21 PM, Cameron Steffen via GitGitGadget wrote:
> From: Cameron Steffen <cam.steffen94@gmail.com>
> 
> move an incorrectly placed backtick
The change below is simple enough, but we prefer using full sentences in the commit messages. This includes capitalization and punctuation.
Thanks,
-Stolee
 
Show 19 quoted lines
> Signed-off-by: Cameron Steffen <cam.steffen94@gmail.com>
> ---
>  Documentation/pretty-formats.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
> index 079598307a..b87e2e83e6 100644
> --- a/Documentation/pretty-formats.txt
> +++ b/Documentation/pretty-formats.txt
> @@ -208,7 +208,7 @@ endif::git-rev-list[]
>  '%GP':: show the fingerprint of the primary key whose subkey was used
>  	to sign a signed commit
>  '%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2
> -	minutes ago`}; the format follows the rules described for the
> +	minutes ago}`; the format follows the rules described for the
>  	`-g` option. The portion before the `@` is the refname as
>  	given on the command line (so `git log -g refs/heads/master`
>  	would yield `refs/heads/master@{0}`).
> 
Johannes Schindelin· Sep 11, 2019, 21:24 UTC · re: Cameron Steffen via GitGitGadget · lore

Re: [PATCH 1/1] doc: small formatting fix

Hi Cameron,
On Mon, 9 Sep 2019, Cameron Steffen via GitGitGadget wrote:
> From: Cameron Steffen <cam.steffen94@gmail.com>
>
> move an incorrectly placed backtick

This sentence is incomplete, and does not really explain _why_ the backtick needs to be moved. Something like this would be much clearer:

	Most likely by mistake, the closing curly brace was added
	_after_ the backtick instead of _before_ it. This breaks the
	formatting. Let's fix that.
The patch looks good, though.

To send another iteration of this patch, amend your commit locally, force-push, and issue another `/submit`.

Ciao, Johannes

Show 22 quoted lines
>
> Signed-off-by: Cameron Steffen <cam.steffen94@gmail.com>
> ---
>  Documentation/pretty-formats.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
> index 079598307a..b87e2e83e6 100644
> --- a/Documentation/pretty-formats.txt
> +++ b/Documentation/pretty-formats.txt
> @@ -208,7 +208,7 @@ endif::git-rev-list[]
>  '%GP':: show the fingerprint of the primary key whose subkey was used
>  	to sign a signed commit
>  '%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2
> -	minutes ago`}; the format follows the rules described for the
> +	minutes ago}`; the format follows the rules described for the
>  	`-g` option. The portion before the `@` is the refname as
>  	given on the command line (so `git log -g refs/heads/master`
>  	would yield `refs/heads/master@{0}`).
> --
> gitgitgadget
>
Derrick Stolee· Sep 11, 2019, 11:49 UTC · re: Cameron Steffen via GitGitGadget · lore

Re: [PATCH 0/1] doc: small formatting fix

On 9/9/2019 7:21 PM, Cameron Steffen via GitGitGadget wrote:
> Edit: I need permission to submit please
Hi Cameron.
When using GitGitGadget, your PR description becomes your cover letter on the mailing list. This is a great place for you to describe how you discovered this problem and if you have looked elsewhere for similar issues to fix up.

Thanks, -Stolee

Show 13 quoted lines
> 
> Cameron Steffen (1):
>   doc: small formatting fix
> 
>  Documentation/pretty-formats.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> 
> base-commit: 75b2f01a0f642b39b0f29b6218515df9b5eb798e
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-330%2Fcamsteffen%2Fpatch-1-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-330/camsteffen/patch-1-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/330
> 
Cameron Steffen via GitGitGadget· Sep 11, 2019, 14:52 UTC · re: Cameron Steffen via GitGitGadget · lore

[PATCH v2 0/1] doc: small formatting fix

Move a closing backtick that was placed one character too soon.
Cameron Steffen (1):
  doc: minor formatting fix
 Documentation/pretty-formats.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
base-commit: 75b2f01a0f642b39b0f29b6218515df9b5eb798e
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-330%2Fcamsteffen%2Fpatch-1-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-330/camsteffen/patch-1-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/330
Range-diff vs v1:
 1:  5248e3332c ! 1:  8e64007452 doc: small formatting fix
     @@ -1,8 +1,8 @@
      Author: Cameron Steffen <cam.steffen94@gmail.com>
      
     -    doc: small formatting fix
     +    doc: minor formatting fix
      
     -    move an incorrectly placed backtick
     +    Move a closing backtick that was placed one character too soon.
      
          Signed-off-by: Cameron Steffen <cam.steffen94@gmail.com>
      
-- 
gitgitgadget
Cameron Steffen via GitGitGadget· Sep 11, 2019, 14:52 UTC · re: Cameron Steffen via GitGitGadget · lore

[PATCH v2 1/1] doc: minor formatting fix

From: Cameron Steffen <cam.steffen94@gmail.com>
Move a closing backtick that was placed one character too soon.
Signed-off-by: Cameron Steffen <cam.steffen94@gmail.com>
---
 Documentation/pretty-formats.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/pretty-formats.txt +1 −1
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index 079598307a..b87e2e83e6 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -208,7 +208,7 @@ endif::git-rev-list[]
 '%GP':: show the fingerprint of the primary key whose subkey was used
 	to sign a signed commit
 '%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2
-	minutes ago`}; the format follows the rules described for the
+	minutes ago}`; the format follows the rules described for the
 	`-g` option. The portion before the `@` is the refname as
 	given on the command line (so `git log -g refs/heads/master`
 	would yield `refs/heads/master@{0}`).
-- 
gitgitgadget
Junio C Hamano· Sep 12, 2019, 18:06 UTC · re: Cameron Steffen via GitGitGadget · lore

Re: [PATCH v2 1/1] doc: minor formatting fix

"Cameron Steffen via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 8 quoted lines
> From: Cameron Steffen <cam.steffen94@gmail.com>
>
> Move a closing backtick that was placed one character too soon.
>
> Signed-off-by: Cameron Steffen <cam.steffen94@gmail.com>
> ---
>  Documentation/pretty-formats.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
Thanks for spotting and fixing.  Will apply.
Show 14 quoted lines
>
> diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
> index 079598307a..b87e2e83e6 100644
> --- a/Documentation/pretty-formats.txt
> +++ b/Documentation/pretty-formats.txt
> @@ -208,7 +208,7 @@ endif::git-rev-list[]
>  '%GP':: show the fingerprint of the primary key whose subkey was used
>  	to sign a signed commit
>  '%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2
> -	minutes ago`}; the format follows the rules described for the
> +	minutes ago}`; the format follows the rules described for the
>  	`-g` option. The portion before the `@` is the refname as
>  	given on the command line (so `git log -g refs/heads/master`
>  	would yield `refs/heads/master@{0}`).
Johannes Schindelin· Sep 11, 2019, 21:21 UTC · re: Cameron Steffen via GitGitGadget · lore

Re: [PATCH 0/1] doc: small formatting fix

Hi Cameron,
On Mon, 9 Sep 2019, Cameron Steffen via GitGitGadget wrote:
> Edit: I need permission to submit please
You got that permission already ;-)

Ciao, Johannes

Show 15 quoted lines
>
> Cameron Steffen (1):
>   doc: small formatting fix
>
>  Documentation/pretty-formats.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
>
> base-commit: 75b2f01a0f642b39b0f29b6218515df9b5eb798e
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-330%2Fcamsteffen%2Fpatch-1-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-330/camsteffen/patch-1-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/330
> --
> gitgitgadget
>

← back to recent threads