From: Michael Lyons <git@michael•lyo.nz>
To: git@vger•kernel.org
Subject: Documentation options: Code or not?
Date: Sun, 04 Jan 2026 13:04:09 -0500 [thread overview]
Message-ID: <2076768.usQuhbGJ8B@debian-mbp> (raw)
I noticed that git-scm.com's documentation for `git-am` has a different color
for the rerere options than it does for the other ones. Those options are
imported from rerere-options.adoc, which adds code backticks to the keys:
`--rerere-autoupdate`::
`--no-rerere-autoupdate`::
After the rerere mechanism reuses a recorded resolution...
I started a quick commit to drop the backticks from rerere-options, but then
sampled a few other doc pages. Some use backticks (git-merge, git-repo), and
some don't (git-prune, git-name-rev). Is there a preferred style? Would an
update to make them consistent be useful or just annoying?
Thank you,
Michael
next reply other threads:[~2026-01-04 18:04 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-04 18:04 Michael Lyons [this message]
2026-01-05 1:54 ` Documentation options: Code or not? Junio C Hamano
2026-01-05 10:01 ` Jean-Noël Avila
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=2076768.usQuhbGJ8B@debian-mbp \
--to=git@michael$(echo .)lyo.nz \
--cc=git@vger$(echo .)kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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