All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, "Jean-Noël Avila" <jn.avila@free.fr>
Subject: Re: [PATCH 2/2] doc: apply new format to git-branch man page
Date: Mon, 17 Mar 2025 14:34:50 -0700	[thread overview]
Message-ID: <xmqqjz8n8hol.fsf@gitster.g> (raw)
In-Reply-To: <b2e7867006e1800eb6dc52902006998afd5800cc.1742056310.git.gitgitgadget@gmail.com> ("Jean-Noël Avila via GitGitGadget"'s message of "Sat, 15 Mar 2025 16:31:50 +0000")

"Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>
>
> - Switch the synopsis to a synopsis block which automatically
>   formats placeholders in italics and keywords in monospace
> - Use _<placeholder>_ instead of <placeholder> in the description
> - Use `backticks` for keywords and more complex option
> descriptions. The new rendering engine applies synopsis rules to
> these spans.

And the one effective reformatting in this patch that is not covered
by the list is that the possible values for some variables, that
were mentioned in the description prose, are now made into
enumerated list.

Nicely done.

  reply	other threads:[~2025-03-17 21:34 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-03-15 16:31 [PATCH 0/2] doc: apply new format to git-branch man page Jean-Noël Avila via GitGitGadget
2025-03-15 16:31 ` [PATCH 1/2] completion: take into account the formatting backticks for options Jean-Noël Avila via GitGitGadget
2025-03-17 20:52   ` Junio C Hamano
2025-03-18  3:58     ` Jean-Noël AVILA
2025-03-18  4:16       ` Junio C Hamano
2025-03-18  4:27         ` Jean-Noël AVILA
2025-03-15 16:31 ` [PATCH 2/2] doc: apply new format to git-branch man page Jean-Noël Avila via GitGitGadget
2025-03-17 21:34   ` Junio C Hamano [this message]
2025-03-19  8:16 ` [PATCH v2 0/2] " Jean-Noël Avila via GitGitGadget
2025-03-19  8:16   ` [PATCH v2 1/2] completion: take into account the formatting backticks for options Jean-Noël Avila via GitGitGadget
2025-03-19  8:16   ` [PATCH v2 2/2] doc: apply new format to git-branch man page Jean-Noël Avila via GitGitGadget

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=xmqqjz8n8hol.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=jn.avila@free.fr \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.