query icon indicating copy to clipboard operation
query copied to clipboard

docs: correct grammar

Open llamington opened this issue 2 months ago β€’ 2 comments

🎯 Changes

βœ… Checklist

  • [x] I have followed the steps in the Contributing guide.
  • [x] I have tested this code locally with pnpm run test:pr.

πŸš€ Release Impact

  • [ ] This change affects published code, and I have generated a changeset.
  • [x] This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Refined wording in the type-safe query disabling guide for improved clarity and readability.

✏️ Tip: You can customize this high-level summary in your review settings.

llamington avatar Dec 07 '25 08:12 llamington

⚠️ No Changeset found

Latest commit: 6033a2fd35275f066bbe97e12510030df2d229a2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Dec 07 '25 08:12 changeset-bot[bot]

Walkthrough

A minor grammatical wording update in the React query disabling guide documentation, changing a phrase in the skipToken section from "keep the query to be type safe" to "the query to be type safe" for improved clarity.

Changes

Cohort / File(s) Summary
Documentation Update
docs/framework/react/guides/disabling-queries.md
Minor wording adjustment in the skipToken section for grammatical correctness

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • #9816: Edits the same documentation page (docs/framework/react/guides/disabling-queries.md) with updates related to skipToken and disabled queries phrasing

Suggested labels

documentation

Poem

🐰 A typo hops away with care,
Grammar polished, smooth and fair,
"Keep" becomes just "be" so right,
One small phrase makes docs so bright! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is incomplete; the 'Changes' section is empty with only a placeholder comment, leaving the specific grammar correction undocumented. Fill in the 'Changes' section with details about what grammar was corrected and why, e.g., 'Changed "keep the query to be type safe" to "the query to be type safe" for improved clarity.'
βœ… Passed checks (2 passed)
Check name Status Explanation
Title check βœ… Passed The title 'docs: correct grammar' accurately describes the main changeβ€”a wording correction in documentation for improved grammar.
Docstring Coverage βœ… Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
πŸ§ͺ Generate unit tests (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

πŸ“œ Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between f15b7fcc01e995ab8835f1b1cc82ebb472c1ff64 and 6033a2fd35275f066bbe97e12510030df2d229a2.

πŸ“’ Files selected for processing (1)
  • docs/framework/react/guides/disabling-queries.md (1 hunks)
πŸ”‡ Additional comments (1)
docs/framework/react/guides/disabling-queries.md (1)

98-98: Grammar correction improves clarity.

Removing "keep" from the phrase reads more naturally and maintains the intended meaning: "you still want the query to be type safe" is more concise than the original phrasing.


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.

❀️ Share

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

coderabbitai[bot] avatar Dec 07 '25 08:12 coderabbitai[bot]