| Message ID | f2e31e70ff6cbf105d00aa5d1188554def34e142.1692194193.git.martin.agren@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 3a6e1ad80bdf5d09cb484e77cc4bfffdd9a15bdf |
| Headers | show |
| Series | some doc fixes on v2.42.0-rc2 | expand |
"Martin Ågren" <martin.agren@gmail.com> writes: > 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. Oops! I didn't notice to distingush ` and ", there are some places still using ", but here we think to use ` is the apppropriate way to surround option and command, etc. in docs, right? > --ref <ref>:: > Manipulate the notes tree in <ref>. This overrides > -- > 2.42.0.rc2.215.g538df5cf27 Thanks for fixing this.
On Thu, 17 Aug 2023 at 04:52, Teng Long <dyroneteng@gmail.com> wrote: > > "Martin Ågren" <martin.agren@gmail.com> writes: > > > 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. > > Oops! I didn't notice to distingush ` and ", there are some places > still using ", but here we think to use ` is the apppropriate > way to surround option and command, etc. in docs, right? Yes, we prefer `backticks`. The coding guidelines go into this around line 730(!). Of course, we're far from perfect. This file does a pretty good job at it, but it could always be better. This patch was mostly "since I'm touching this anyway, let's do this now so any future cleanup will be slightly easier". Martin
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
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(-)