From: Derrick Stolee <stolee@gmail.com>
To: Andrei Rybak <rybak.a.v@gmail.com>,
git@vger.kernel.org, dstolee@microsoft.com
Subject: Re: [PATCH] config doc: indent descriptions of feature.* variables
Date: Tue, 1 Jun 2021 21:17:54 -0400 [thread overview]
Message-ID: <057126a2-81c4-41cf-e41a-52a24a0c9a52@gmail.com> (raw)
In-Reply-To: <20210602001132.459705-1-rybak.a.v@gmail.com>
On 6/1/2021 8:11 PM, Andrei Rybak wrote:
> Config variables feature.experimental and feature.manyFiles are grouped
> together under "feature.*". However, this is not easily visible when
> scanning the help page of git-config.
>
> Indent the descriptions of individual feature.* config variables to help
> the reader distinguish this group of variables.
I'm not sure how these extra tabs help in the rendered text, or in
the formatted HTML output for the git-scm.com web page. I do believe
that we would want to re-wrap the paragraphs to ensure we are not using
too many characters per line.
Is there precedence for a simple tabbing like this? I was able to find
a similar grouping for advice.* in Documentation/config/advice.txt, but
it uses a different kind of grouping. Perhaps reorganize the file to use
that strategy instead?
Or, perhaps just point me to an existing use of this pattern.
Thanks,
-Stolee
next prev parent reply other threads:[~2021-06-02 1:18 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-02 0:11 [PATCH] config doc: indent descriptions of feature.* variables Andrei Rybak
2021-06-02 1:14 ` Đoàn Trần Công Danh
2021-06-02 1:17 ` Derrick Stolee [this message]
2021-06-02 16:59 ` Taylor Blau
2021-06-02 20:38 ` Todd Zullinger
2021-06-02 23:04 ` Felipe Contreras
2021-06-03 7:02 ` Ævar Arnfjörð Bjarmason
2021-06-03 7:43 ` Ævar Arnfjörð Bjarmason
2021-06-03 18:03 ` Felipe Contreras
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=057126a2-81c4-41cf-e41a-52a24a0c9a52@gmail.com \
--to=stolee@gmail.com \
--cc=dstolee@microsoft.com \
--cc=git@vger.kernel.org \
--cc=rybak.a.v@gmail.com \
/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).