fix: no endnotes section for unreferenced footnotes#236
Merged
Conversation
The endnotes section was emitted whenever any footnote definition was collected, even if none were referenced. A footnote defined but never referenced produced a stray empty section with an empty ordered list. Gate the section on referenced footnotes (footnoteNumbers) only, so an unreferenced definition produces no output.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #236 +/- ##
=========================================
Coverage 91.89% 91.89%
+ Complexity 3523 3522 -1
=========================================
Files 106 106
Lines 9958 9958
=========================================
Hits 9151 9151
Misses 807 807 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
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.
What
The endnotes section was emitted whenever any footnote definition was collected (
collectedFootnotes), regardless of whether it was referenced. A footnote defined but never referenced produced a stray, empty section:Before,
text\n\n[^f]: note:Fix
Gate the section on referenced footnotes only (
footnoteNumbers, populated when a reference is rendered). An unreferenced definition now produces no output. Referenced footnotes are unchanged.Backport of the footnote part of markup-carve/carve-php#31 (shared parser lineage).
Tests
Added a case asserting an unreferenced footnote definition emits no
doc-endnotessection. Full suite and official corpus green.