docs: fix malformed and dangling cross-references#4103
Merged
Conversation
Five source-level xref bugs found while auditing the cross-document links (independent of the resolver): - qtvcp-widgets.adoc (x2), qtplasmac.adoc: <<id>>[Label] is malformed; the bracket leaked as literal text after the link. Use <<id,Label>>. - o-code.adoc: <<Numbering>> had no matching anchor (the section's auto-id is _numbering), so it rendered as literal [Numbering]. Add an explicit [[ocode:numbering]] anchor matching the file convention. - pncconf.adoc: <<sub:install:sec:latency-test,...>> used a stale prefix; the real anchor is sec:latency-test. - remap.adoc: drop a commented-out line carrying a dangling <<remap:extracting-words>> ref, so nobody copies the broken form.
Member
|
👍 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Five source-level cross-reference bugs found while auditing the doc links. Independent of the resolver (#4100); these are wrong in the source regardless.
<<id>>[Label]is malformed. The[Label]leaked as literal text after the link instead of being the link text. Fixed to<<id,Label>>.<<Numbering>>had no matching anchor (the section's auto id is_numbering), so it rendered as literal[Numbering]. Added an explicit[[ocode:numbering]]anchor, matching the file's convention.<<sub:install:sec:latency-test,...>>used a stale prefix; the real anchor issec:latency-test.<<remap:extracting-words>>ref (a stale duplicate of the line below it), so nobody copies the broken form.Verified with a full English
make htmldocs: checkref reports "all links are good!" and the four rendered links now resolve correctly.