Skip to content

docs(repo): Add trailing comma after e.g. and i.e. in JSDoc#9201

Merged
SarahSoutoul merged 6 commits into
mainfrom
ss/DOCS-11950-typedoc-eg-ie
Jul 21, 2026
Merged

docs(repo): Add trailing comma after e.g. and i.e. in JSDoc#9201
SarahSoutoul merged 6 commits into
mainfrom
ss/DOCS-11950-typedoc-eg-ie

Conversation

@SarahSoutoul

@SarahSoutoul SarahSoutoul commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Description

Standardize JSDoc punctuation across the Typedoc-source packages (@clerk/backend and @clerk/shared) so that e.g. and i.e. are always followed by a comma, matching the clerk-docs style guide and keeping the generated clerk-typedoc output consistent. Comment-only change; no runtime behavior is affected.

Fixes this Linear ticket. Sibling to this.

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:

Standardize JSDoc punctuation across the Typedoc-source packages
(@clerk/backend, @clerk/nextjs, @clerk/react, @clerk/shared) so that
e.g. and i.e. are always followed by a comma, matching the clerk-docs
style guide and keeping the generated clerk-typedoc output consistent.
Comment-only change; no runtime behavior is affected.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@changeset-bot

changeset-bot Bot commented Jul 20, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: edf7550

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

This PR includes changesets to release 23 packages
Name Type
@clerk/backend Patch
@clerk/shared Patch
@clerk/astro Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/hono Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/tanstack-react-start Patch
@clerk/testing Patch
@clerk/chrome-extension Patch
@clerk/clerk-js Patch
@clerk/electron Patch
@clerk/expo-passkeys Patch
@clerk/expo Patch
@clerk/headless Patch
@clerk/localizations Patch
@clerk/msw Patch
@clerk/react Patch
@clerk/ui Patch
@clerk/vue Patch
@clerk/swingset Patch

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 Jul 20, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment Jul 21, 2026 8:22am
swingset Ready Ready Preview, Comment Jul 21, 2026 8:22am

Request Review

@pkg-pr-new

pkg-pr-new Bot commented Jul 20, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: edf7550

@SarahSoutoul
SarahSoutoul marked this pull request as ready for review July 20, 2026 21:30
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: f052b56c-de81-4ebf-b7bb-e68d0731a5e6

📥 Commits

Reviewing files that changed from the base of the PR and between 0333c31 and edf7550.

📒 Files selected for processing (1)
  • .typedoc/__tests__/__snapshots__/clerk-properties.mdx
🔗 Linked repositories identified

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

  • clerk/clerk_go (manual)
  • clerk/dashboard (manual)
  • clerk/accounts (manual)
  • clerk/backoffice (manual)
  • clerk/clerk (manual) → reviewed against open PR #2984 ss/DOCS-11950 instead of the default branch
  • clerk/clerk-docs (manual)
  • clerk/cloudflare-workers (manual)

📝 Walkthrough

Walkthrough

Standardizes JSDoc examples, abbreviations, punctuation, and related wording across backend and shared packages. The changeset marks @clerk/backend and @clerk/shared for patch releases. No runtime logic, public signatures, type shapes, or API behavior changes.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: wobsoriano, alexisintech

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: JSDoc punctuation updates for e.g. and i.e. comments.
Description check ✅ Passed The description matches the changeset and correctly describes the comment-only JSDoc punctuation standardization.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
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.

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

@github-actions

github-actions Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-07-21T08:22:54.066Z

Summary

Metric Count
Packages analyzed 19
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 edf7550.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@manovotny

Copy link
Copy Markdown
Contributor

Pushed some changes directly in 0333c31.

  • Dropped @clerk/nextjs and @clerk/react from the changeset — the PR only touches @clerk/backend and @clerk/shared
  • Switched e.g., to i.e., in the OrganizationSyncTarget doc comment, since that clause defines rather than gives an example

@SarahSoutoul
SarahSoutoul merged commit 858a689 into main Jul 21, 2026
51 checks passed
@SarahSoutoul
SarahSoutoul deleted the ss/DOCS-11950-typedoc-eg-ie branch July 21, 2026 08:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants