# [PATCH] doc: do not break sentences into "lego" pieces

2 messages from 2025-10-05 to 2025-10-06. Participants: Jean-Noël Avila via GitGitGadget, brian m. carlson.
Thread: https://gitlist.dev/t/64254

## Jean-Noël Avila via GitGitGadget, 2025-10-05 21:12

Subject: [PATCH] doc: do not break sentences into "lego" pieces
Message-ID: <pull.1982.git.1759698724134.gitgitgadget@gmail.com>
URL: https://gitlist.dev/e/pull.1982.git.1759698724134.gitgitgadget%40gmail.com

```
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>

The sentence needs to be whole to be properly translated.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
---
    doc: do not break sentences into "lego" pieces
    
    The sentence needs to be whole to be properly translated.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1982%2Fjnavila%2Fremove_sentence_lego-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1982/jnavila/remove_sentence_lego-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1982

 Documentation/pretty-options.adoc | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/Documentation/pretty-options.adoc b/Documentation/pretty-options.adoc
index 8aac51dbe7..658e462b25 100644
--- a/Documentation/pretty-options.adoc
+++ b/Documentation/pretty-options.adoc
@@ -61,15 +61,16 @@ and `fuller`).
 ifndef::git-rev-list[]
 `--notes[=<ref>]`::
 	Show the notes (see linkgit:git-notes[1]) that annotate the
-	commit, when showing the commit log message.  This is the default
+	commit, when showing the commit log message.
 ifndef::with-breaking-changes[]
-	for `git log`, `git show` and `git whatchanged` commands when
+This is the default for `git log`, `git show` and `git whatchanged`
+commands when there is no `--pretty`, `--format`, or `--oneline` option given
+on the command line.
 endif::with-breaking-changes[]
 ifdef::with-breaking-changes[]
-	for `git log` and `git show` commands when
+This is the default for `git log` and `git show` commands when there is no
+`--pretty`, `--format`, or `--oneline` option given on the command line.
 endif::with-breaking-changes[]
-	there is no `--pretty`, `--format`, or `--oneline` option given
-	on the command line.
 +
 By default, the notes shown are from the notes refs listed in the
 `core.notesRef` and `notes.displayRef` variables (or corresponding

base-commit: 79ee0dce2a61b7552f9b5c73f0cf2d974a20a029
-- 
gitgitgadget

```

## brian m. carlson, 2025-10-06 21:10

Subject: Re: [PATCH] doc: do not break sentences into "lego" pieces
Message-ID: <aOQwQq0KJBLlda0m@fruit.crustytoothpaste.net>
URL: https://gitlist.dev/e/aOQwQq0KJBLlda0m%40fruit.crustytoothpaste.net
In-Reply-To: <pull.1982.git.1759698724134.gitgitgadget@gmail.com>

```
On 2025-10-05 at 21:12:04, Jean-Noël Avila via GitGitGadget wrote:
> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>
> 
> The sentence needs to be whole to be properly translated.

This patch seems reasonable and I agree this is the right thing to do to
make the documentation more easily translatable (as well as generally
more legible).
-- 
brian m. carlson (they/them)
Toronto, Ontario, CA

```
