chore(backend): Add jsdoc comments for user methods #6091
Conversation
🦋 Changeset detectedLatest commit: 96387be The changes in this PR will be included in the next version bump. This PR includes changesets to release 11 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 ↗︎
|
📝 WalkthroughWalkthroughDescriptive JSDoc comments were added to four getter methods within the Changes
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🧰 Additional context used🪛 markdownlint-cli2 (0.17.2).changeset/mean-apes-do.md5-5: First line in a file should be a top-level heading (MD041, first-line-heading, first-line-h1) ⏰ Context from checks skipped due to timeout of 90000ms (25)
🔇 Additional comments (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
packages/backend/src/api/resources/User.ts (4)
188-193: Suggest adding an explicit@returnstag to JSDoc.
The comment correctly states what this getter returns, but including@returns {EmailAddress | null}will improve generated docs and make the return type explicit.
195-200: Suggest adding an explicit@returnstag to JSDoc.
Consider annotating this block with@returns {PhoneNumber | null}to clearly document the return type for consumers of the generated docs.
202-207: Suggest adding an explicit@returnstag to JSDoc.
It’s helpful to include@returns {Web3Wallet | null}so the docs accurately reflect the type of the primary web3 wallet getter.
209-214: Suggest enhancing comment with return type and behavior note.
Add@returns {string | null}and optionally note that it trims and returnsnullif both names are missing, e.g.:/** * The full name of the user, or null if neither first nor last name is set. * @returns {string | null} */
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/backend/src/api/resources/User.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Build Packages
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
Co-authored-by: panteliselef <[email protected]>
Description
The methods on the
Userclass aren't documented for typedoc.clerk/clerk-docs#2292 (comment)
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit