[BUGFIX] Fix broken confval permalink reference in test documentation#1144
[BUGFIX] Fix broken confval permalink reference in test documentation#1144CybotTM wants to merge 1 commit into
Conversation
The permalink URL `rendertest:confval-case-array` cannot resolve because: - It creates a ReferenceNode with linkType='std:label' and anchor='confval-case-array' - But the confval target is registered as linkType='std:confval' with anchor='case-array' - The reference resolver looks in the wrong inventory section Changed to use the proper `:confval:`case-array`` role which resolves correctly. See PR for detailed technical analysis.
|
still investigating ... |
|
Closing this PR - the original permalink format was correct and should work. Root Cause FoundThe actual bug was a priority ordering conflict in the feature branch's incremental rendering infrastructure:
Since higher priority runs first, Fix AppliedChanged This ensures it runs before Why Only Feature Branch?
The original documentation was correct - no changes needed there. |
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