-
Notifications
You must be signed in to change notification settings - Fork 381
chore(repo): Add @unionReturnHeadings
Typedoc blockTag
#5596
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
LekoArts
merged 10 commits into
main
from
lekoarts/eco-596-add-subheadings-to-tables-of-union-type-returns
Apr 14, 2025
Merged
chore(repo): Add @unionReturnHeadings
Typedoc blockTag
#5596
LekoArts
merged 10 commits into
main
from
lekoarts/eco-596-add-subheadings-to-tables-of-union-type-returns
Apr 14, 2025
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
🦋 Changeset detectedLatest commit: c6ccfdb The changes in this PR will be included in the next version bump. This PR includes changesets to release 22 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
@unionReturnHeadings
Typedoc blockTag
tmilewski
approved these changes
Apr 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR adds a custom
@unionReturnHeadings
blockTag we can use on functions that return a union type.For example,
useSignIn
gets this custom block tag:And the result will be:
Also, for the "table goes here" part the description (third column) is copied from the first item to all other items inside the tabs.
Note for reviewers: Double check if the headings are appropriate for the different unions.
This PR also improves the output in some places by adjusting the theme. I've also added missing links to other resources.
Fixes ECO-596
Fixes ECO-597
Checklist
pnpm test
runs as expected.pnpm build
runs as expected.Type of change