Skip to content

docs: fix 'allows to keep' grammar in retainSearchParams - #8408

Open
mrchatam wants to merge 1 commit into
TanStack:mainfrom
mrchatam:docs-fix-retain-search-params-allows
Open

mrchatam wants to merge 1 commit into
TanStack:mainfrom
mrchatam:docs-fix-retain-search-params-allows

Conversation

@mrchatam

@mrchatam mrchatam commented Sep 13, 2026

Copy link
Copy Markdown

Fixes non-idiomatic grammar in the `retainSearchParams` API docs: "allows to keep" → "allows keeping".

Docs-only wording fix.

Summary by CodeRabbit

  • Documentation
    • Clarified the wording describing how the retainSearchParams search middleware keeps search parameters.

@coderabbitai

coderabbitai Bot commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 84486b2e-d5ab-4a77-b20e-845d7874c67b

📥 Commits

Reviewing files that changed from the base of the PR and between ae68535 and af0fbd6.

📒 Files selected for processing (1)
  • docs/router/api/router/retainSearchParamsFunction.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The retainSearchParams documentation sentence was reworded. No functional or public API changes were made.

Changes

retainSearchParams documentation

Layer / File(s) Summary
Middleware description wording
docs/router/api/router/retainSearchParamsFunction.md
The description now uses “allows keeping search params.”

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to af0fb

No runtime or API behavior changes are introduced.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description accurately explains the docs-only grammar fix, but it omits the required Checklist and Release Impact sections from the repository template. Add the Checklist section and mark the applicable items. Add the Release Impact section and select the docs/CI/dev-only option.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation grammar fix for retainSearchParams and accurately summarizes the change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with 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.

❤️ Share

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

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