Skip to content

chore(repo): Adjust Typedoc union output #5641

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
merged 2 commits into from
Apr 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/busy-humans-draw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Improve JSDoc comments
4 changes: 3 additions & 1 deletion .typedoc/custom-theme.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,9 @@ class ClerkMarkdownThemeContext extends MarkdownThemeContext {
const items = headings.map(i => `'${i}'`).join(', ');
const tabs = md.map(i => `<Tab>${i}</Tab>`).join('\n');

return `<Tabs items={[${items}]}>
return `This function returns a discriminated union type. There are multiple variants of this type available which you can select by clicking on one of the tabs.

<Tabs items={[${items}]}>
${tabs}
</Tabs>`;
},
Expand Down
2 changes: 1 addition & 1 deletion packages/types/src/hooks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export type UseAuthReturn =
*/
sessionId: undefined;
/**
* The JWT claims for the current session.
* The current user's [session claims](https://clerk.com/docs/backend-requests/resources/session-tokens).
*/
sessionClaims: undefined;
/**
Expand Down