Skip to content

docs(angular-query): fix "allows to" grammar in JSDoc comments#10890

Open
dfedoryshchev wants to merge 1 commit into
TanStack:mainfrom
dfedoryshchev:docs/fix-allows-to-grammar-in-angular-query-jsdoc
Open

docs(angular-query): fix "allows to" grammar in JSDoc comments#10890
dfedoryshchev wants to merge 1 commit into
TanStack:mainfrom
dfedoryshchev:docs/fix-allows-to-grammar-in-angular-query-jsdoc

Conversation

@dfedoryshchev
Copy link
Copy Markdown

@dfedoryshchev dfedoryshchev commented Jun 5, 2026

🎯 Changes

allows to <verb> is ungrammatical: allow needs an object (allow X to ...) or a gerund. The JSDoc comments on the Angular adapter's *Options helpers and provideTanStackQuery use it, so they're switched to the gerund: Allows sharing and re-using ... and Allows configuring ....

✅ Checklist

🚀 Release Impact

  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Updated JSDoc documentation text for query options, infinite query options, mutation options, and providers in the Angular Query package.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 5, 2026

Wondering what really moved? Review this PR in Change Stack to inspect semantic changes, definitions, and references.

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6387a1e2-0a42-4b55-ab51-bd335ab06ab2

📥 Commits

Reviewing files that changed from the base of the PR and between ba7fbc4 and 2bec468.

📒 Files selected for processing (4)
  • packages/angular-query-experimental/src/infinite-query-options.ts
  • packages/angular-query-experimental/src/mutation-options.ts
  • packages/angular-query-experimental/src/providers.ts
  • packages/angular-query-experimental/src/query-options.ts

📝 Walkthrough

Walkthrough

This PR updates JSDoc documentation comments across four files in the @tanstack/angular-query-experimental package. The wording is improved for consistency: gerund verb forms replace infinitive constructions, and minor phrasing adjustments enhance readability. No runtime logic, type signatures, or exported APIs are modified.

Changes

Angular Query JSDoc Documentation Updates

Layer / File(s) Summary
JSDoc wording improvements across API functions
packages/angular-query-experimental/src/infinite-query-options.ts, packages/angular-query-experimental/src/query-options.ts, packages/angular-query-experimental/src/mutation-options.ts, packages/angular-query-experimental/src/providers.ts
JSDoc comments for infiniteQueryOptions, queryOptions, mutationOptions, provideTanStackQuery, and provideAngularQuery are updated with consistent grammar improvements: "Allows to share and re-use" becomes "Allows sharing and re-using", and "Allows to configure" becomes "Allows configuring".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Docs shine brighter now, I declare,
Grammar refined with proper care,
Gerunds flow smooth where infinitives were,
Little tweaks that make words purr!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description provides a clear explanation of the grammar issue and the fix applied. However, the checklist is incomplete: one required item (testing with 'pnpm run test:pr') is unchecked. Clarify whether 'pnpm run test:pr' was executed locally or confirm why testing was not performed. For documentation-only changes, explain why testing may not be applicable.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: fixing grammatical issues in JSDoc comments related to 'allows to' phrasing in the Angular Query adapter.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

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