Repository navigation
fix: preserve native interface link resolution - #18
Conversation
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Render interface names components/table-of-contents.html.twig, .changelog/native-interface-links.md |
The table of contents renders interface names as styled text instead of links. The changelog describes interface-link resolution through phpDocumentor’s native renderer. |
Verify interface output tests/fixture/src/InterfaceExamples.php, tests/verify-output.php |
New fixtures and checks cover the documented local interface, the unresolved external interface, and a class without interfaces. The checks also require generated pages for each fixture. |
Priority:
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Bug fix
Merge Risk: 
5c59b
-
No actionable merge-blocking risk is established for this change.
Pre-merge checks: 
-
Check name Status Explanation Title check The title "fix: preserve native interface link resolution" matches the main change. The table-of-contents markup now keeps phpDocumentor's native class:short route as the only link renderer, and the r… Description check The description states the problem: an unresolved external interface gets a fabricated local-page link, and a documented local interface gets nested anchors. It explains the fix (native class:short re… Docstring Coverage Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Title check
-
Explanation
The title "fix: preserve native interface link resolution" matches the main change. The table-of-contents markup now keeps phpDocumentor's native class:short route as the only link renderer, and the redundant outer anchor becomes a neutral span. The title is specific, short, and follows a conventional commit style.
Full details: Description check
-
Explanation
The description states the problem: an unresolved external interface gets a fabricated local-page link, and a documented local interface gets nested anchors. It explains the fix (native class:short renderer kept, outer anchor replaced by a span), the new interface fixtures, and the validation performed. It matches the changeset closely.
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 1 functions across 2 files. (2 skipped: 2 unsupported.)
-
Finishing Touches
-
📝 Generate docstrings
-
- Commit to this branch
- Create a new PR
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
A rabbit checks the names in view,
A local link points to its page.
An outside name stays plain and true,
No-interface pages skip that stage.
The tests confirm each path and case,
Then hop away with code in place.
Comment @coderabbitai help to get the list of available commands.
Changelog✅ Contribution check passed. Head: Base: Contribution: 1 new valid fragment(s). Policy: ordinary.
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
An unresolved external interface currently receives a fabricated local-page link in the table of contents; a documented local interface receives nested anchors. Keep phpDocumentor's native class:short route as the sole link renderer and replace only the redundant outer anchor with a neutral span. External names remain visible without invented destinations, and internal links resolve once.
Add real-render fixtures for an external interface, a documented interface and a class without interfaces. Existing theme, assets, source examples and consumer skill contracts remain intact. This is the template portion of php-fast-forward/code-standards#31; the separate native graph-setting issue is not fixed here. No new upstream issue is created by this PR.
Reviewed commit: 5c59bc6; base 98b8735; tree abdf3b3d937b35ae48c5aa0dda17ef3a51a08489. Independent review found no pending findings in the four changed files.
Validation: focused RED/GREEN native phpDocumentor 3.9.1 render reproduced the invalid links and passed after the change. Exact-lock official signed shim 3.10.0 passed Composer strict/platform, canonical fixture generation (20 pages), consumer-skill rendering, both canonical renders from the Git export-ignore archive, and JS interaction tests. The project lock and global configuration remain unchanged. Published Changelog 0.4.0 check --since=origin/main passed one patch fragment. Local PHP was 8.5.12; hosted PHP matrix and current Changelog channel checks remain pending.
No runtime API or dependency change, replacement renderer, generated HTML rewrite, merge, tag or release is included. Consumer integration must use a reviewed compatible upstream publication or an explicitly approved exact candidate reference; published template 2.2.2 does not contain this fix.