fix(jsx-ast): hide redundant headers and badges for overloaded methods - #1038
fix(jsx-ast): hide redundant headers and badges for overloaded methods#1038moshams272 wants to merge 2 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1038 +/- ##
==========================================
+ Coverage 89.37% 89.43% +0.06%
==========================================
Files 203 203
Lines 18986 19023 +37
Branches 1769 1779 +10
==========================================
+ Hits 16968 17013 +45
+ Misses 2011 2004 -7
+ Partials 7 6 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
cc @nodejs/web thoughts? |
|
when you have long type table for the constructor the overlaod table seem alone |
What if we make a Nested ToC like we keep the output of that PR, but make the codeblock, that contains its signature, has an anchor id, and put it under the main one with its signature in the ToC. Something like that: - factorizeModule
- factorizeModule(options, callback): void
...But it'll not be good in ToC, WDUT?! |
|
Or creating a table under the header and before the function, that table contains all signature with an anchor id for each of them, so we will have one link in ToC. |
ovflowd
left a comment
There was a problem hiding this comment.
I think I'm fine with this, but wonder if all overloads should simply be added to one signature. (the table gets redesigned/updated) to ensure the Type box and the table of properties/return type follow the possible overloads. But that's a more complex PR that'd probably require more design.
I can even imagine that using code tabs could be useful for overloads. So instead of rendering each overload below each other, we have tabs, default being first implementation, then the other tabs being overloads. What do you all think?
Need to put +1, but I'm not member, so... +0.1 ;) |
Description
This PR removes the heading from the overloads function; just keep one for the first function that appears like grouping them.
Validation
Before:
After:
Related Issues
None
Check List
pnpm testand all tests passed.pnpm run format:check&pnpm run lint.