git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Martin Ågren" <martin.agren@gmail.com>
To: Teng Long <dyroneteng@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 2/4] notes doc: tidy up `--no-stripspace` paragraph
Date: Thu, 17 Aug 2023 08:52:23 +0200	[thread overview]
Message-ID: <CAN0heSoNTPaX6Z-MZnhHHN3CUc5ez7dgjvT-khknAHZeYfPQUw@mail.gmail.com> (raw)
In-Reply-To: <20230817025222.75033-1-tenglong.tl@alibaba-inc.com>

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

  reply	other threads:[~2023-08-17  6:53 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 ` [PATCH 2/4] notes doc: tidy up `--no-stripspace` paragraph Martin Ågren
2023-08-17  2:52   ` Teng Long
2023-08-17  6:52     ` Martin Ågren [this message]
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=CAN0heSoNTPaX6Z-MZnhHHN3CUc5ez7dgjvT-khknAHZeYfPQUw@mail.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).