Skip to contentSkip to conversation

Documentation: remove redundant 'instead' in --subject-prefix

PATCH In review Lucas Seiki Oshiro 2 participants 2 messages Jun 4 – Jun 5 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: remove redundant 'instead' in --subject-prefix

The documentation for --subject-prefix has two words "instead" in the same sentence, making it a little bit confusing to read.

Change the order of the phrase to a more natural "Use [...] instead of [...]" structure.

---
 Documentation/git-format-patch.adoc | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
Documentation/git-format-patch.adoc +3 -4
index 5662382450..f7905c0f7c 100644
@@ -221,10 +221,9 @@ populated with placeholder text.
 	for generating the cover letter.
 
 --subject-prefix=<subject-prefix>::
-	Instead of the standard '[PATCH]' prefix in the subject
-	line, instead use '[<subject-prefix>]'. This can be used
-	to name a patch series, and can be combined with the
-	`--numbered` option.
+	Use '[<subject-prefix>]' instead of the standard '[PATCH]'
+	prefix in the subject line. This can be used to name a patch
+	series, and can be combined with the `--numbered` option.
 +
 The configuration variable `format.subjectPrefix` may also be used
 to configure a subject prefix to apply to a given repository for
Signature · 1 line
2.50.1 (Apple Git-155)
#1 lore raw

Documentation/git-format-patch.adoc populated with placeholder text. · line 226

Quoted 8 lines · Lucas Seiki Oshiro

--subject-prefix=<subject-prefix>::

Documentation/git-format-patch.adoc +3 -4
-	Instead of the standard '[PATCH]' prefix in the subject
-	line, instead use '[<subject-prefix>]'. This can be used
-	to name a patch series, and can be combined with the
-	`--numbered` option.
+	Use '[<subject-prefix>]' instead of the standard '[PATCH]'
+	prefix in the subject line. This can be used to name a patch
+	series, and can be combined with the `--numbered` option.

Agreed, this reads more smoothly.