Skip to contentSkip to conversation

doc: do not break sentences into "lego" pieces

PATCH In review Jean-Noël Avila via GitGitGadget 2 participants 2 messages Oct 5, 2025 – Oct 6, 2025 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: do not break sentences into "lego" pieces

From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>

The sentence needs to be whole to be properly translated.

---
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(-)
Documentation/pretty-options.adoc +6 -5
index 8aac51dbe7..658e462b25 100644
@@ -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

Signature · 1 line
gitgitgadget
#1 lore raw
Quoted 3 lines · Jean-Noël Avila via GitGitGadget

From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>

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

Signature · 2 lines
brian m. carlson (they/them)
Toronto, Ontario, CA