[1/1] doc: small formatting fix
diff mbox series

Message ID 5248e3332c90e91c1c6a911090d331f005789014.1568071262.git.gitgitgadget@gmail.com
State New
Headers show
Series
  • doc: small formatting fix
Related show

Commit Message

kdnakt via GitGitGadget Sept. 9, 2019, 11:21 p.m. UTC
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(-)

Comments

Derrick Stolee Sept. 11, 2019, 11:50 a.m. UTC | #1
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
 
> 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 Sept. 11, 2019, 9:24 p.m. UTC | #2
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

>
> 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
>

Patch
diff mbox series

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}`).