Skip to content

fix(jsx-ast): hide redundant headers and badges for overloaded methods - #1038

Open
moshams272 wants to merge 2 commits into
nodejs:mainfrom
moshams272:fix/hide-redundant-overload-headings
Open

fix(jsx-ast): hide redundant headers and badges for overloaded methods#1038
moshams272 wants to merge 2 commits into
nodejs:mainfrom
moshams272:fix/hide-redundant-overload-headings

Conversation

@moshams272

Copy link
Copy Markdown
Contributor

Description

This PR removes the heading from the overloads function; just keep one for the first function that appears like grouping them.

Validation

Before:

image

After:

image

Related Issues

None

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run pnpm test and all tests passed.
  • I have check code formatting with pnpm run format:check & pnpm run lint.
  • I've covered new added functionality with unit tests if necessary.

@moshams272
moshams272 requested a review from a team as a code owner August 14, 2026 18:39
@vercel

vercel Bot commented Aug 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api-docs-tooling Ready Ready Preview Aug 14, 2026 6:56pm

Request Review

@codecov

codecov Bot commented Aug 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.43%. Comparing base (15b3f3e) to head (875e150).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@avivkeller

Copy link
Copy Markdown
Member

cc @nodejs/web thoughts?

@AugustinMauroy

Copy link
Copy Markdown
Member

when you have long type table for the constructor the overlaod table seem alone

@moshams272

moshams272 commented Aug 15, 2026

Copy link
Copy Markdown
Contributor Author

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?!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants