Skip to content

fix(theme): replace 'Call Signature' with the real signature in functions overload - #187

Open
moshams272 wants to merge 4 commits into
webpack:mainfrom
moshams272:fix/rendering-overloads
Open

fix(theme): replace 'Call Signature' with the real signature in functions overload#187
moshams272 wants to merge 4 commits into
webpack:mainfrom
moshams272:fix/rendering-overloads

Conversation

@moshams272

@moshams272 moshams272 commented Jul 15, 2026

Copy link
Copy Markdown
Member

Summary

This PR shows the real signature of standalone functions and classes' methods overloads instead of Call Signature, removes the main method heading if the function is overloaded to prevent duplicate titles, and removes the shared general comment from rendering as it hasn't parent after we removed the main header above the overloads.

Before:

image

After:

image

Summary by CodeRabbit

  • Documentation
    • Improved API documentation for overloaded methods by displaying each overload with its specific method signature.
    • Added clearer headings for callable members while avoiding duplicate headings for constructors and routed members.
    • Preserved existing parameter, return, and description details.

@vercel

vercel Bot commented Jul 15, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
webpack-doc-kit Ready Ready Preview Aug 23, 2026 3:32am

Request Review

@coderabbitai

coderabbitai Bot commented Aug 23, 2026

Copy link
Copy Markdown

Warning

Your free Security trial is over. An organization admin can activate billing to continue.

@moshams272
moshams272 force-pushed the fix/rendering-overloads branch from 0ad0b91 to fd668a6 Compare August 23, 2026 03:31
@moshams272
moshams272 marked this pull request as ready for review August 23, 2026 03:31
@github-actions github-actions Bot added the tests Pull requests that update tests label Aug 23, 2026
@coderabbitai

coderabbitai Bot commented Aug 23, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

getMemberTitle now accepts an optional specific signature and uses its parameters when available. Theme partials render individual headings for overloaded signatures, suppress duplicate headings for selected member types, and replace generic call-signature headings with context-aware member titles. The theme snapshot now shows headings for each overload signature.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed Docstring check was indeterminate for this PR — some files could not be analyzed in time. Not blocking.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: replacing generic overload headings with real function signatures.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5f23aea9-968e-45e2-bce2-4f7cd90fac52

📥 Commits

Reviewing files that changed from the base of the PR and between f2af951 and fd668a6.

📒 Files selected for processing (3)
  • plugins/shared/titles.mjs
  • plugins/theme/partials/index.mjs
  • tests/theme/theme.test.mjs.snapshot

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

Comment thread plugins/theme/partials/index.mjs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tests Pull requests that update tests theme tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants