fix: split non-parameter items from typed lists in signature tables - #1023
Open
btea wants to merge 3 commits into
Open
fix: split non-parameter items from typed lists in signature tables#1023btea wants to merge 3 commits into
btea wants to merge 3 commits into
Conversation
When a loose markdown list in API docs starts with typed parameters (e.g. `actual`, `expected`, `Returns`) but also contains plain prose bullets (e.g. algorithm complexity notes in `util.diff`), the entire list was treated as a parameter signature table. The non-parameter items had no name or type, causing them to render as empty sections. Split the list at the first non-parameter item: typed items become the FunctionSignature table, and remaining items render as regular markdown. Affected pages: util, fs, quic (31 mixed lists across 4 files).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1023 +/- ##
==========================================
- Coverage 89.43% 89.37% -0.07%
==========================================
Files 203 203
Lines 18871 18986 +115
Branches 1763 1769 +6
==========================================
+ Hits 16878 16968 +90
- Misses 1986 2011 +25
Partials 7 7 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
AugustinMauroy
approved these changes
Aug 11, 2026
avivkeller
reviewed
Aug 11, 2026
avivkeller
approved these changes
Aug 11, 2026
avivkeller
reviewed
Aug 11, 2026
Co-authored-by: Aviv Keller <me@aviv.sh>
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
3 participants
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.
Description
When a loose markdown list in API docs starts with typed parameters (e.g.
actual,expected,Returns) but also contains plain prose bullets (e.g. algorithm complexity notes inutil.diff), the entire list was treated as a parameter signature table. The non-parameter items had no name or type, causing them to render as empty sections.Split the list at the first non-parameter item: typed items become the FunctionSignature table, and remaining items render as regular markdown.
Affected pages: util, fs, quic (31 mixed lists across 4 files).
Validation
Related Issues
Check List
node --run testand all tests passed.node --run format:check&node --run lint.