Skip to content

fix(repo): flatten Pick parameters in TypeDoc output - #9700

Closed
SarahSoutoul wants to merge 1 commit into
mainfrom
codex/docs-11879-pick-parameters
Closed

fix(repo): flatten Pick parameters in TypeDoc output#9700
SarahSoutoul wants to merge 1 commit into
mainfrom
codex/docs-11879-pick-parameters

Conversation

@SarahSoutoul

Copy link
Copy Markdown
Contributor

Description

Flatten TypeDoc parameter tables when a parameter uses the built-in Pick<T, K> utility and K resolves to string literal keys. The parent parameter remains in the table, followed by rows for only the selected properties with their original types and JSDoc. Unsupported or partially resolved Pick shapes retain the existing output.

Adds an end-to-end snapshot for organization.createDomain(), which now documents params?.enrollmentMode? without leaking the omitted name property.

Verified with pnpm typedoc:generate:skip-build (0 errors) and the TypeDoc Vitest suite (39 tests passed). A full TypeDoc build and generation also completed successfully before the final type-only cleanup.

Resolves DOCS-11879.

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:

@SarahSoutoul SarahSoutoul self-assigned this Sep 9, 2026
@changeset-bot

changeset-bot Bot commented Sep 9, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 0887de9

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 Sep 9, 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 Sep 9, 2026 11:45pm UTC
swingset Ready Ready Preview Sep 9, 2026 11:45pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

Comment @coderabbitai help to get the list of available commands.

@pkg-pr-new

pkg-pr-new Bot commented Sep 9, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 0887de9

@SarahSoutoul
SarahSoutoul deleted the codex/docs-11879-pick-parameters branch September 9, 2026 23:52
@SarahSoutoul
SarahSoutoul restored the codex/docs-11879-pick-parameters branch September 9, 2026 23:52
@SarahSoutoul SarahSoutoul reopened this Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant