git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Martin Ågren" <martin.agren@gmail.com>
To: git@vger.kernel.org
Cc: Teng Long <dyroneteng@gmail.com>
Subject: [PATCH 2/4] notes doc: tidy up `--no-stripspace` paragraph
Date: Wed, 16 Aug 2023 16:24:34 +0200	[thread overview]
Message-ID: <f2e31e70ff6cbf105d00aa5d1188554def34e142.1692194193.git.martin.agren@gmail.com> (raw)
In-Reply-To: <cover.1692194193.git.martin.agren@gmail.com>

Where we document the `--no-stripspace` option, remove a superfluous
"For" to fix the grammar. Mark option names and command names using
`backticks` to set them in monospace.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Documentation/git-notes.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 9043274ce8..f8310e56a8 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -179,9 +179,9 @@ OPTIONS
 --[no-]stripspace::
 	Strip leading and trailing whitespace from the note message.
 	Also strip out empty lines other than a single line between
-	paragraphs. For lines starting with `#` will be stripped out
-	in non-editor cases like "-m", "-F" and "-C", but not in
-	editor case like "git notes edit", "-c", etc.
+	paragraphs. Lines starting with `#` will be stripped out
+	in non-editor cases like `-m`, `-F` and `-C`, but not in
+	editor case like `git notes edit`, `-c`, etc.
 
 --ref <ref>::
 	Manipulate the notes tree in <ref>.  This overrides
-- 
2.42.0.rc2.215.g538df5cf27


  parent reply	other threads:[~2023-08-16 14:26 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-08-16 14:24 [PATCH 0/4] some doc fixes on v2.42.0-rc2 Martin Ågren
2023-08-16 14:24 ` [PATCH 1/4] notes doc: split up run-on sentences Martin Ågren
2023-08-17  2:22   ` Teng Long
2023-08-16 14:24 ` Martin Ågren [this message]
2023-08-17  2:52   ` [PATCH 2/4] notes doc: tidy up `--no-stripspace` paragraph Teng Long
2023-08-17  6:52     ` Martin Ågren
2023-08-16 14:24 ` [PATCH 3/4] show-ref doc: fix carets in monospace Martin Ågren
2023-08-16 14:24 ` [PATCH 4/4] rev-list-options: fix typo in `--stdin` documentation Martin Ågren
2023-08-16 18:41   ` Junio C Hamano
2023-08-16 18:52     ` Junio C Hamano
2023-08-17  6:51       ` Martin Ågren
2023-08-16 18:35 ` [PATCH 0/4] some doc fixes on v2.42.0-rc2 Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=f2e31e70ff6cbf105d00aa5d1188554def34e142.1692194193.git.martin.agren@gmail.com \
    --to=martin.agren@gmail.com \
    --cc=dyroneteng@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).