fix(shared): Fix link typedoc error #7251
Conversation
🦋 Changeset detectedLatest commit: 6420482 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types 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 GitHub.
|
WalkthroughA changeset file placeholder was added to the repository. A documentation comment block was removed from the ClerkAPIResponseError class without modifying the class implementation or behavior. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
SarahSoutoul
changed the title
| /** | ||
| * Class representing a Clerk API Response Error. | ||
| */ | ||
| export class ClerkAPIResponseError extends ClerkError implements ClerkAPIResponseErrorInterface { |
There was a problem hiding this comment.
Do you specifically not want this class to be included in the typedoc output?
There was a problem hiding this comment.
Yes. It's already being outputted, so there was a duplication. This comment was added as part of my work, but realized it caused the duplication.
There was a problem hiding this comment.
Context here: clerk/clerk-docs#2649 (comment)
There was a problem hiding this comment.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
.changeset/green-roses-decide.md(1 hunks)packages/shared/src/errors/clerkApiResponseError.ts(0 hunks)
💤 Files with no reviewable changes (1)
- packages/shared/src/errors/clerkApiResponseError.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (2)
.changeset/green-roses-decide.md (2)
1-2: Request visibility into the ClerkAPIResponseError documentation change.The AI summary indicates that a documentation comment block was removed from the
ClerkAPIResponseErrorclass inpackages/shared/src/errors/clerkApiResponseError.ts, but that file was not provided for review. The PR title mentions a "link typedoc error" fix.Please verify:
- What specific JSDoc comment or link was causing the typedoc error?
- Why was the entire documentation block removed rather than fixing the problematic link?
- Are there any side effects to removing documentation from this error class?
1-2: PR submission is incomplete.The PR checklist items (
pnpm test,pnpm build, JSDoc updates, documentation) are not marked as completed. Before merging, please ensure:
- Changes have been tested locally
- Build succeeds with
pnpm build- All JSDoc/documentation is accurate given the changes
- Any affected documentation is updated
| --- | ||
| --- |
There was a problem hiding this comment.
Changeset file is incomplete and will fail validation.
The changeset file must declare which package(s) were changed and the bump type (patch/minor/major) between the --- delimiters. The current file contains only empty delimiters.
Based on the PR title mentioning "fix(shared)", the changeset should declare the @clerk/shared package.
Apply this diff to add the required package declaration:
---
---
+@clerk/shared: patch
+"Fix link typedoc error"
+---Note: Replace patch with minor or major if appropriate for your versioning strategy.
Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In .changeset/green-roses-decide.md around lines 1 to 2, the changeset is empty
and will fail validation; update the section between the '---' delimiters to
declare the changed package and bump type by adding an entry for @clerk/shared
with the desired release level (e.g., patch), for example replace the empty
content with a YAML block listing the package name and "patch" (or
"minor"/"major" if appropriate) so the file contains the required package
declaration and version bump type.
@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: |
Description
Context: clerk/clerk-docs#2649 (comment)
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit