docs: Correct typo in usage.mdx #6908
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughDocumentation update: corrected a code snippet in www/docs/client/tanstack-react-query/usage.mdx to use the React Query option key staleTime instead of stateTime. No code or API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@cademis is attempting to deploy a commit to the trpc Team on Vercel. A member of the Team first needs to authorize it. |
![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)
www/docs/client/tanstack-react-query/usage.mdx (4)
28-28: Standardize brand capitalization to “TanStack”.Multiple instances use “Tanstack”. Consider normalizing to “TanStack” for brand consistency.
Apply this diff:
-... with Tanstack React Query. +... with TanStack React Query. ... -Provides a type-safe wrapper around [Tanstack's `queryOptions` function]... +Provides a type-safe wrapper around [TanStack's `queryOptions` function]... ... - // Any Tanstack React Query options + // Any TanStack React Query options ... -Provides a type-safe wrapper around [Tanstack's `infiniteQueryOptions` function]... +Provides a type-safe wrapper around [TanStack's `infiniteQueryOptions` function]... ... -Since Tanstack React Query uses fuzzy matching for query keys, you can also... +Since TanStack React Query uses fuzzy matching for query keys, you can also... ... - // Any Tanstack React Query filter + // Any TanStack React Query filter ... - // Any Tanstack React Query filter + // Any TanStack React Query filterAlso applies to: 64-64, 72-72, 120-120, 142-142, 164-164, 176-176
46-48: Fix grammar: “used to manipulated” → “used to manipulate”.Minor readability tweak.
- // Create a QueryKey which can be used to manipulated many methods + // Create a QueryKey that can be used to manipulate many methods // on TanStack's QueryClient in a type-safe manner
187-189: Typo: “identify function” → “identity function”.These are identity-style helpers that return the options while preserving types.
-Available for all mutation procedures. Provides a type-safe identify function for constructing options that can be passed to `useMutation`. +Available for all mutation procedures. Provides a type-safe identity function for constructing options that can be passed to `useMutation`.-Available for all subscription procedures. Provides a type-safe identify function for constructing options that can be passed to `useSubscription`. +Available for all subscription procedures. Provides a type-safe identity function for constructing options that can be passed to `useSubscription`.Also applies to: 208-210
239-241: Wording: “lastly received” → “most recently received”.Slight polish for natural phrasing.
- subscription.data; // The lastly received data - subscription.error; // The lastly received error + subscription.data; // The most recently received data + subscription.error; // The most recently received error
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
www/docs/client/tanstack-react-query/usage.mdx(1 hunks)
⏰ 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). (19)
- GitHub Check: E2E-tests (minimal-react)
- GitHub Check: E2E-tests (vercel-edge-runtime)
- GitHub Check: E2E-tests (fastify-server)
- GitHub Check: E2E-tests (express-server)
- GitHub Check: E2E-tests (soa)
- GitHub Check: E2E-tests (next-minimal-starter)
- GitHub Check: E2E-tests (.test/ssg)
- GitHub Check: e2e-legacy-node (next-prisma-todomvc, 18.x)
- GitHub Check: E2E-tests (.experimental/next-app-dir)
- GitHub Check: e2e-legacy-node (next-prisma-todomvc, 20.x)
- GitHub Check: e2e-legacy-node (next-prisma-websockets-starter, 20.x)
- GitHub Check: e2e-legacy-node (next-prisma-starter, 18.x)
- GitHub Check: Test a monorepo using built declaration files
- GitHub Check: Release using pkg.pr.new
- GitHub Check: E2E-tests (Deno) (deno-deploy)
- GitHub Check: typecheck
- GitHub Check: test
- GitHub Check: Lint and auto-fix
- GitHub Check: Analyze (typescript)
🔇 Additional comments (1)
www/docs/client/tanstack-react-query/usage.mdx (1)
72-74: Correct option key: stateTime → staleTime (confirmed).Nice catch. This aligns with TanStack React Query’s option naming and fixes a confusing typo in the docs.
@trpc/client
@trpc/next
@trpc/react-query
@trpc/server
@trpc/tanstack-react-query
@trpc/upgrade
commit: |
|
This pull request has been locked because we are very unlikely to see comments on closed issues. If you think, this PR is still necessary, create a new one with the same branch. Thank you. |
2 participants
🎯 Changes
What changes are made in this PR? Is it a feature or a bug fix?
Typo fix
✅ Checklist
Summary by CodeRabbit