Re: [PATCH] doc: add more AsciiDoc cross-references
- From
Julia Evans <julia@jvns.ca>
- Date
- Sep 24, 2026, 17:22 UTC
- Message-ID
- <31577b6f-79b6-456f-9ecd-d1a3df6209e2@app.fastmail.com>
- In-Reply-To
- <xmqqse2y371a.fsf@gitster.g>
Show 16 quoted lines
> To see if I understand correctly, let me rephrase the second > paragraph a bit (not as an attempt to offer an improvement; by > restating the above differently while expressing what I take to be > the same thing, we will see whether I misunderstood what you wrote > if my version ends up saying what you did not intend), as I found it > somewhat puzzling. > > The short form <<EXAMPLES>> uses EXAMPLES as both the link > target (which is not shown to the end user except in the > browser's location bar when the link is visited) and the > clickable text. In different parts of the document, however, > the text in HTML may need to be rendered as "EXAMPLES" or > [EXAMPLES], which can be achieved by using the > <<EXAMPLES,"EXAMPLES">> or <<EXAMPLES,[EXAMPLES]>> form. For > consistency, always use the longer form, even when there are no > such typesetting constraints.
I meant something different, let me try again (with Peff's corrections as well):
The reason for using the more verbose <<EXAMPLES,EXAMPLES>>
(instead of <<EXAMPLES>>) is that in some cases, <<EXAMPLES>> is
rendered as `the section called "EXAMPLES"` or `[EXAMPLES]`.
<<EXAMPLES,EXAMPLES>> is rendered as just `EXAMPLES`, which gives us
more control over the output.("in some cases" is code for "I still don't fully understand exactly when each one happens and why")
> I'll mark the topic as Expecting a reroll in my working copy of the > "What's cooking" report of the next issue. > > Thanks.