From: "Julia Evans" <julia@jvns.ca>
To: "Junio C Hamano" <gitster@pobox.com>
Cc: "Julia Evans" <gitgitgadget@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH 2/2] doc: add new Git tutorial for beginners
Date: Wed, 21 Oct 2026 17:24:37 -0400 [thread overview]
Message-ID: <25e3db8e-b011-4af4-99ff-5ecb840e92d2@app.fastmail.com> (raw)
In-Reply-To: <xmqqwlrbotyd.fsf@gitster.g>
On Wed, Oct 21, 2026, at 1:16 PM, Junio C Hamano wrote:
> Junio C Hamano <gitster@pobox.com> writes:
>
>> ... indeed, that is how I caught a handful of mistakes over the
>> course of this project that I suspect I otherwise wouldn't have
>> found. Once found, however, such a mistake is easier to
>> correct.
>
> Sorry, but re-reading my previous message, I realize my preference
> was not very clear. The last sentence there should have ended
> with "easier to correct with the ATX-style prefix format."
>
> I do not have a strong preference either way myself. However, this
> is practically a brand-new document. If you think it would be
> easier to adopt and stay consistent with the prefix format, I am
> happy to go with that direction.
I do find it easier to stay consistent with the prefix format, but
I also ran into an issue where if I format the DESCRIPTION section
like this:
== DESCRIPTION
then I get this error from `make lint-docs`:
gittutorial.adoc:779: has no required 'DESCRIPTION' section!
So it seems easier for now to stick to the usual format, since
it feels weird to me to mix two different ways of formatting
headings in the same document, and I don't want to update
the linter to understand the other way of formatting headings.
next prev parent reply other threads:[~2026-10-21 21:24 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-06 19:37 [PATCH 0/2] WIP: doc: add new git tutorial Julia Evans via GitGitGadget
2026-10-06 19:37 ` [PATCH 1/2] doc: remove gittutorial Julia Evans via GitGitGadget
2026-10-06 19:37 ` [PATCH 2/2] doc: add new Git tutorial for beginners Julia Evans via GitGitGadget
2026-10-07 19:48 ` D. Ben Knoble
2026-10-19 14:24 ` Julia Evans
2026-10-19 16:49 ` Ben Knoble
2026-10-19 20:42 ` Julia Evans
2026-10-19 21:14 ` D. Ben Knoble
2026-10-20 17:11 ` Junio C Hamano
2026-10-20 17:59 ` Julia Evans
2026-10-20 18:26 ` Junio C Hamano
2026-10-20 18:27 ` Junio C Hamano
2026-10-20 18:45 ` Junio C Hamano
2026-10-20 19:13 ` Junio C Hamano
2026-10-21 17:16 ` Junio C Hamano
2026-10-21 21:24 ` Julia Evans [this message]
2026-10-20 18:22 ` Julia Evans
2026-10-20 18:30 ` Junio C Hamano
2026-10-07 19:26 ` [PATCH 0/2] WIP: doc: add new git tutorial D. Ben Knoble
2026-10-19 14:55 ` [PATCH v2 0/2] " Julia Evans via GitGitGadget
2026-10-19 14:55 ` [PATCH v2 1/2] doc: remove gittutorial Julia Evans via GitGitGadget
2026-10-19 14:55 ` [PATCH v2 2/2] doc: add new Git tutorial for beginners Julia Evans via GitGitGadget
2026-10-20 1:24 ` [PATCH v2 0/2] doc: add new git tutorial Junio C Hamano
2026-10-20 2:24 ` Ben Knoble
2026-10-20 12:18 ` Julia Evans
2026-10-20 18:50 ` Tuomas Ahola
2026-10-20 19:13 ` Junio C Hamano
2026-10-23 15:17 ` [PATCH v3 " Julia Evans via GitGitGadget
2026-10-23 15:17 ` [PATCH v3 1/2] doc: remove gittutorial Julia Evans via GitGitGadget
2026-10-23 15:17 ` [PATCH v3 2/2] doc: add new Git tutorial for beginners Julia Evans via GitGitGadget
2026-10-23 18:01 ` [PATCH v3 0/2] doc: add new git tutorial Ben Knoble
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=25e3db8e-b011-4af4-99ff-5ecb840e92d2@app.fastmail.com \
--to=julia@jvns.ca \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.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