Skip to content

docs(shared): fix useReverification options table - #10865

Open
SarahSoutoul wants to merge 5 commits into
mainfrom
ss/fix-reverification-typedoc-table
Open

SarahSoutoul wants to merge 5 commits into
mainfrom
ss/fix-reverification-typedoc-table

Conversation

@SarahSoutoul

@SarahSoutoul SarahSoutoul commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Description

Move the passReverificationResult code example from its property JSDoc to the useReverification() hook's example section. TypeDoc flattened the fenced example into the options table, where the | in ReverificationResult | undefined split the Markdown row into an extra column. The generated options table now has three columns, and the example remains in the generated hook docs.

Spell out the OAuth token exchange scope restriction as “double quotes or backslashes.” TypeDoc had dropped the literal backslash and rendered empty inline code in the generated parameters table.

Run pnpm typedoc:generate:skip-build to check the generated options table and hook example. The hand-written hook page in clerk/clerk does not embed the generated hook example, so displaying it on that page would need a separate docs change.

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-bot Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3081018

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When 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

@vercel

vercel Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
clerk-js-sandbox Ready Ready Preview Nov 18, 2026 10:21am UTC
mosaic-docs Error Error Nov 18, 2026 10:21am UTC
swingset Ready Ready Preview Nov 18, 2026 10:21am UTC

Request Review

@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The useReverification documentation now includes an example that passes the reverification result to a fetcher. If reverification.passwordReset is true, the example reloads the user. Otherwise, it calls updatePassword with the supplied parameters. The previous example was removed from the passReverificationResult option documentation. An empty changeset frontmatter file was added. The OAuth scope parameter documentation now describes disallowed characters as “double quotes” and “backslashes”; the declared behavior is unchanged.

Estimated code review effort: 2 (Simple) | ~8 minutes

Possibly related PRs

  • clerk/javascript#10851: It moves passReverificationResult to a new options type, which changes the type structure used to generate the options table documented here.

Suggested reviewers: wyattjoh

Merge Risk: Minimal · up to 30810

This change only adjusts documentation wording and moves a code example. It does not alter runtime behavior, so merge risk is minimal.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title "docs(shared): fix useReverification options table" matches the main change. The PR moves the passReverificationResult code example out of the property JSDoc into the useReverification() hoo…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description check Passed The description states that the passReverificationResult code example moves from its property JSDoc to the useReverification() hook example section, which fixes a TypeDoc options table that split into…
Full details: Title check

Explanation

The title "docs(shared): fix useReverification options table" matches the main change. The PR moves the passReverificationResult code example out of the property JSDoc into the useReverification() hook example, which fixes the generated options table that TypeDoc split into an extra column. The title names the affected package, the hook, and the table, so a reviewer scanning history can identify the primary change. It does not mention the example move, but that detail is secondary.

Full details: Description check

Explanation

The description states that the passReverificationResult code example moves from its property JSDoc to the useReverification() hook example section, which fixes a TypeDoc options table that split into an extra column because of the pipe character in ReverificationResult | undefined. It also explains the OAuth token exchange scope wording change to double quotes or backslashes. Both points match the changed files: the changeset, useReverification.ts, and OAuthApplicationsApi.ts. The description is specific and on topic.

Finishing Touches

Fix failing CI checks

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Linked repositories: Some configured repositories could not be included in this review. Cross-repository analysis may be incomplete. Please check linked-repository access and settings.

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: clerk/javascript
  • Branch: main
  • File: .coderabbit.yaml
  • Commit: c71b7d3
  • Layers: Repository YAML (base), Organization UI (inherited)
  • Review profile: ASSERTIVE
  • Plan: Team
  • Run ID: adc00c3a-fcc0-4d1d-b783-3f5011d8a294
Commits

Reviewing files that changed from the base of the PR and between 3098a4d and 3081018.

Files selected for processing: 1

  • packages/backend/src/api/endpoints/OAuthApplicationsApi.ts
Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

Included review availability: This review used your included allowance. 8 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 10 reviews per hour.

@pkg-pr-new

pkg-pr-new Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@10865

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@10865

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@10865

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@10865

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@10865

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@10865

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@10865

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@10865

@clerk/expo-biometrics

npm i https://pkg.pr.new/@clerk/expo-biometrics@10865

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@10865

@clerk/expo-native-components

npm i https://pkg.pr.new/@clerk/expo-native-components@10865

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@10865

@clerk/express

npm i https://pkg.pr.new/@clerk/express@10865

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@10865

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@10865

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@10865

@clerk/mosaic

npm i https://pkg.pr.new/@clerk/mosaic@10865

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@10865

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@10865

@clerk/react

npm i https://pkg.pr.new/@clerk/react@10865

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@10865

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@10865

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@10865

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@10865

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@10865

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@10865

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@10865

commit: 3081018

@SarahSoutoul SarahSoutoul self-assigned this Nov 18, 2026
@SarahSoutoul
SarahSoutoul marked this pull request as ready for review November 18, 2026 09:57
@SarahSoutoul

Copy link
Copy Markdown
Contributor Author

@wobsoriano Is this failing deployment expected?

@github-actions

github-actions Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-11-18T10:25:47.180Z

Summary

Metric Count
Packages analyzed 20
Packages with changes 0
🔴 Breaking changes 0
🟡 Non-breaking changes 0
🟢 Additions 0

No API Changes Detected

All packages have stable APIs with no detected changes.


Report generated by Break Check

Last ran on 3081018.

This branch was successfully deployed

2 active deployments
Preview – swingset — 3081018a Deployed Nov 18, 2026 by vercel[bot]
Preview – clerk-js-sandbox — 3081018a Deployed Nov 18, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant