Skip to content

pr-git-2416/jvns/anchors-v2

tagged this 25 Sep 00:52
From: Julia Evans <julia@jvns.ca>

Instead of saying "see EXAMPLES below", say "see <<EXAMPLES,EXAMPLES>>
below" to make the man pages easier to navigate on the web.

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 `EXAMPLES`, which gives us more
control over the output.

This also changes some of the HTML IDs of the headings from `_examples`
to `EXAMPLES`, which has the potential to break some links.

Signed-off-by: Julia Evans <julia@jvns.ca>

Submitted-As: https://lore.kernel.org/git/pull.2416.v2.git.git.1790297546771.gitgitgadget@gmail.com
In-Reply-To: https://lore.kernel.org/git/pull.2416.git.git.1790105342890.gitgitgadget@gmail.com
Assets 2
Loading