Repository navigation
docs: link @see targets with @ref and gate bare @see names - #466
Conversation
MrDocs treats the text after @see as an ordinary paragraph and does not auto-link names in it, so every "See Also" entry written as `@see task` rendered as plain text. warn-broken-ref only checks @ref targets, so nothing reported it. Rewrite all 165 bare @see entries in the public headers as `@see @ref name`, moving prose out of the @see lines and qualifying the one name that resolved to a constructor. Add style guide rule B6 and a doc-lint.mjs check that flags any @see paragraph, including wrapped lines, holding anything but @ref items. B6 joins the doc_lint gate spec, with selftest fixtures and header-relative locations in the gate report.
|
An automated preview of the documentation is available at https://466.capy.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-10-20 22:04:23 UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #466 +/- ##
===========================================
+ Coverage 98.40% 98.45% +0.04%
===========================================
Files 137 137
Lines 7293 7293
===========================================
+ Hits 7177 7180 +3
+ Misses 116 113 -3
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 4 files with indirect coverage changes Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
|
GCOVR code coverage report https://466.capy.prtest3.cppalliance.org/gcovr/index.html Build time: 2026-10-20 22:32:03 UTC |
3 participants
MrDocs treats the text after @see as an ordinary paragraph and does not auto-link names in it, so every "See Also" entry written as
@see taskrendered as plain text. warn-broken-ref only checks @ref targets, so nothing reported it. Rewrite all 165 bare @see entries in the public headers as@see @ref name, moving prose out of the @see lines and qualifying the one name that resolved to a constructor.Add style guide rule B6 and a doc-lint.mjs check that flags any @see paragraph, including wrapped lines, holding anything but @ref items. B6 joins the doc_lint gate spec, with selftest fixtures and header-relative locations in the gate report.