Re: [PATCH 2/4] notes doc: tidy up `--no-stripspace` paragraph

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, 17 Aug 2023 at 04:52, Teng Long <dyroneteng@xxxxxxxxx> wrote:
>
> "Martin Ågren" <martin.agren@xxxxxxxxx> 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




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux