[0/4] some doc fixes on v2.42.0-rc2

Message

Martin Ågren Aug. 16, 2023, 2:24 p.m. UTC

Looking into the changes to our documentation from v2.41.0 up to
v2.42.0-rc2, I found some improvements we could make. I've cc'd the
original authors on this cover letter and the respective patches.

I realize we're fairly late in the release cycle. The impact of these
patches is small, which could mean they're "low risk" or "low benefit"
depending on how you want to look at it.

Martin

Martin Ågren (4):
  notes doc: split up run-on sentences
  notes doc: tidy up `--no-stripspace` paragraph
  show-ref doc: fix carets in monospace
  rev-list-options: fix typo in `--stdin` documentation

 Documentation/git-notes.txt        | 15 +++++++--------
 Documentation/git-show-ref.txt     |  4 ++--
 Documentation/rev-list-options.txt |  2 +-
 3 files changed, 10 insertions(+), 11 deletions(-)

Comments

Junio C Hamano Aug. 16, 2023, 6:35 p.m. UTC | #1

Martin Ågren <[e-mail]> writes:

> Looking into the changes to our documentation from v2.41.0 up to
> v2.42.0-rc2, I found some improvements we could make. I've cc'd the
> original authors on this cover letter and the respective patches.

It is good that you looked into these, as everything else is slow
during the pre-release freeze period, and we are prioritizing
regressions made during the latest cycle.  Watching out for bugs in
the documentation updated during the cycle is much better than
building a random new feature ;-)

> I realize we're fairly late in the release cycle. The impact of these
> patches is small, which could mean they're "low risk" or "low benefit"
> depending on how you want to look at it.

That is certainly true.

Thanks.