Fix module summary pages to display all function overloads #3038
+618
−416
Conversation
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
Fixes TypeStrong#3037 This commit comprehensively addresses the issue where module summary pages only displayed the first function overload, hiding additional variants and providing incomplete API documentation. ## Changes Made ### 1. Module Summary Pages (moduleReflection.tsx) - Functions with multiple overloads now display ALL signatures in the module summary, not just the first one - Each overload signature is individually clickable and links to its specific anchor on the detail page (e.g., #getvalue, #getvalue-1) - Maintains fallback to original behavior for single-signature functions ### 2. Function Detail Pages (reflection.tsx) - Added an "Overloads" summary section at the top of function detail pages when 2+ overloads exist - Provides quick table-of-contents style navigation to jump to any specific overload - Includes short descriptions when available ### 3. CHANGELOG.md - Documented the feature addition and bug fixes ## Impact Before: Users had no way to discover additional function overloads from module summaries, requiring navigation to each function's detail page. After: Complete API surface is visible at a glance with direct links to detailed documentation for each overload. ## Files Modified - src/lib/output/themes/default/partials/moduleReflection.tsx - src/lib/output/themes/default/templates/reflection.tsx - CHANGELOG.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Fixes #3037
This commit comprehensively addresses the issue where module summary pages only displayed the first function overload, hiding additional variants and providing incomplete API documentation.
Changes Made
1. Module Summary Pages (moduleReflection.tsx)
2. Function Detail Pages (reflection.tsx)
3. CHANGELOG.md
Impact
Before: Users had no way to discover additional function overloads from module summaries, requiring navigation to each function's detail page.
After: Complete API surface is visible at a glance with direct links to detailed documentation for each overload.
Files Modified