Skip to content

doc: repair the cross-reference to the Registry affinity section - #119

Open
jll63 wants to merge 1 commit into
boostorg:developfrom
jll63:fix/registry-affinity-xref
Open

jll63 wants to merge 1 commit into
boostorg:developfrom
jll63:fix/registry-affinity-xref

Conversation

@jll63

@jll63 jll63 commented Sep 17, 2026

Copy link
Copy Markdown
Collaborator

(Written by Claude Code, on behalf of @jll63.)

Found by rendering the docs; nothing in the build fails on it.

#111 added see <<Registry affinity>> below to registries_and_policies.adoc and
hard-wrapped it at the 79-column margin, which put a newline inside the macro:

the classes involved declare no affinity of their own - see <<Registry
affinity>> below.

Asciidoctor does not match a title reference across the break, so it fell back to
the unresolved form. The page rendered

see <a href="#Registry affinity">[Registry affinity]</a> below.
  • a literal [Registry affinity] in square brackets, pointing at a fragment with a
    space in it, which matches no anchor. The section's own id is the generated
    _registry_affinity, so the link was dead in both directions.

The build does say so - possible invalid reference: Registry\naffinity - but the
line sits among the section-title-out-of-sequence warnings, the job still passes,
and the rendered sentence looks plausible enough to read past.

Fixed with an explicit anchor, which is what the page's siblings already use:
<<custom_registries>>, <<implementation_notes>> and
<<registering_classes_by_reflection>> each pair with a [#id] line above their
heading. That spelling survives rewrapping and does not break if the heading is
reworded.

Rebuilt to check: the link now renders as Registry affinity -> #registry_affinity,
and the build reports no invalid references.

While rendering I also cross-checked every @ref target in the headers against the
labels MrDocs turned into links, per the procedure in CLAUDE.md. All 110 resolve,
including the new ones from #103 and #110; grep -rl MRDOCS doc/html/ is empty.

🤖 Generated with Claude Code

boostorg#111 added `see <<Registry affinity>> below` and hard-wrapped it at the
79-column margin, putting a newline inside the macro. Asciidoctor does
not match a title reference across the break, so it fell back to the
unresolved form: the page rendered a literal `[Registry affinity]` in
square brackets, linking to `#Registry affinity` - a fragment with a
space in it, which matches no anchor. The section's own id is the
generated `_registry_affinity`.

The build says so ("possible invalid reference: Registry\naffinity"),
but among the section-title-out-of-sequence warnings the line is easy to
miss, and the rendered page still looks plausible.

Use an explicit anchor, as the page's siblings do (`<<custom_registries>>`,
`<<implementation_notes>>`, `<<registering_classes_by_reflection>>` all
pair with a `[#id]` line above the heading). That spelling also survives
rewrapping, and it does not break if the heading is ever reworded.

Verified by rebuilding: the link now renders as `Registry affinity` ->
`#registry_affinity`, and the build reports no invalid references.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JrW75AraKw18w6dcLjTuZB
@cppalliance-bot

Copy link
Copy Markdown

An automated preview of the documentation is available at https://119.openmethod.prtest3.cppalliance.org/libs/openmethod/doc/html/index.html

If more commits are pushed to the pull request, the docs will rebuild at the same URL.

2026-09-18 00:02:55 UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants