[BUGFIX] Fix broken confval permalink reference in test documentation #1144
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.
Summary
Fixes broken permalink reference in
Documentation-rendertest/Confval/Index.rstthat causes test failures with--minimal-testflag.Discovery
While working on PR #1143 (performance optimizations), CI tests failed with:
This was causing
make test-rendertestto exit with code 1 because--minimal-testsetsfailOnError('warning').Technical Analysis
The broken line was:
Why it fails
The permalink URL
rendertest:confval-case-arrayis processed byReplacePermalinksNodeTransformerwhich creates:ReferenceNodewithtargetReference='confval-case-array'linkType='std:label'(default)But the actual confval anchor (defined in
ConfvalTrees.rstwith:name: case-array) is registered as:anchor='case-array'(without theconfval-prefix)linkType='std:confval'The reference resolver looks for:
But the target exists at:
They don't match! The permalink format doesn't support specifying link types.
The correct approach
Using the proper
:confval:text role:This creates a
ReferenceNodewithlinkType='std:confval'andanchor='case-array', which resolves correctly.Question for maintainers
This broken reference was introduced in PR #975 (commit c310707) on May 4, 2025 by @linawolf.
Was this intentional? Possible interpretations:
confval-case-arrayto work like:confval:case-array`` but they're fundamentally differentrendertest:confval:case-array?If this was intentional as a "broken link" test case, please let me know and I'll adjust the fix accordingly (perhaps adding a comment explaining it's intentionally broken, or moving the test).
Test plan
make test-rendertestpasses