Skip to content

Commit ab939fd

Browse files
authoredApr 16, 2025··
chore(repo): Adjust Typedoc union output (#5641)
1 parent c2712e7 commit ab939fd

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed
 

‎.changeset/busy-humans-draw.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@clerk/types': patch
3+
---
4+
5+
Improve JSDoc comments

‎.typedoc/custom-theme.mjs

+3-1
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,9 @@ class ClerkMarkdownThemeContext extends MarkdownThemeContext {
297297
const items = headings.map(i => `'${i}'`).join(', ');
298298
const tabs = md.map(i => `<Tab>${i}</Tab>`).join('\n');
299299

300-
return `<Tabs items={[${items}]}>
300+
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.
301+
302+
<Tabs items={[${items}]}>
301303
${tabs}
302304
</Tabs>`;
303305
},

‎packages/types/src/hooks.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export type UseAuthReturn =
4343
*/
4444
sessionId: undefined;
4545
/**
46-
* The JWT claims for the current session.
46+
* The current user's [session claims](https://clerk.com/docs/backend-requests/resources/session-tokens).
4747
*/
4848
sessionClaims: undefined;
4949
/**

0 commit comments

Comments
 (0)
Please sign in to comment.