Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dfedoryshchev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/angular-query-experimental/src/infinite-query-options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export type DefinedInitialDataInfiniteOptions<
}

/**
* Allows to share and re-use infinite query options in a type-safe way.
* Allows sharing and re-using infinite query options in a type-safe way.
*
* The `queryKey` will be tagged with the type from `queryFn`.
* @param options - The infinite query options to tag with the type from `queryFn`.
Expand Down Expand Up @@ -110,7 +110,7 @@ export function infiniteQueryOptions<
}

/**
* Allows to share and re-use infinite query options in a type-safe way.
* Allows sharing and re-using infinite query options in a type-safe way.
*
* The `queryKey` will be tagged with the type from `queryFn`.
* @param options - The infinite query options to tag with the type from `queryFn`.
Expand Down Expand Up @@ -141,7 +141,7 @@ export function infiniteQueryOptions<
}

/**
* Allows to share and re-use infinite query options in a type-safe way.
* Allows sharing and re-using infinite query options in a type-safe way.
*
* The `queryKey` will be tagged with the type from `queryFn`.
* @param options - The infinite query options to tag with the type from `queryFn`.
Expand Down Expand Up @@ -172,7 +172,7 @@ export function infiniteQueryOptions<
}

/**
* Allows to share and re-use infinite query options in a type-safe way.
* Allows sharing and re-using infinite query options in a type-safe way.
*
* The `queryKey` will be tagged with the type from `queryFn`.
* @param options - The infinite query options to tag with the type from `queryFn`.
Expand Down
4 changes: 2 additions & 2 deletions packages/angular-query-experimental/src/mutation-options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { DefaultError, WithRequired } from '@tanstack/query-core'
import type { CreateMutationOptions } from './types'

/**
* Allows to share and re-use mutation options in a type-safe way.
* Allows sharing and re-using mutation options in a type-safe way.
*
* **Example**
*
Expand Down Expand Up @@ -66,7 +66,7 @@ export function mutationOptions<
>

/**
* Allows to share and re-use mutation options in a type-safe way.
* Allows sharing and re-using mutation options in a type-safe way.
*
* **Example**
*
Expand Down
4 changes: 2 additions & 2 deletions packages/angular-query-experimental/src/providers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export function provideQueryClient(
/**
* Sets up providers necessary to enable TanStack Query functionality for Angular applications.
*
* Allows to configure a `QueryClient` and optional features such as developer tools.
* Allows configuring a `QueryClient` and optional features such as developer tools.
*
* **Example - standalone**
*
Expand Down Expand Up @@ -115,7 +115,7 @@ export function provideTanStackQuery(
/**
* Sets up providers necessary to enable TanStack Query functionality for Angular applications.
*
* Allows to configure a `QueryClient`.
* Allows configuring a `QueryClient`.
* @param queryClient - A `QueryClient` instance.
* @returns A set of providers to set up TanStack Query.
* @see https://tanstack.com/query/v5/docs/framework/angular/quick-start
Expand Down
8 changes: 4 additions & 4 deletions packages/angular-query-experimental/src/query-options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export type DefinedInitialDataOptions<
}

/**
* Allows to share and re-use query options in a type-safe way.
* Allows sharing and re-using query options in a type-safe way.
*
* The `queryKey` will be tagged with the type from `queryFn`.
*
Expand Down Expand Up @@ -85,7 +85,7 @@ export function queryOptions<
}

/**
* Allows to share and re-use query options in a type-safe way.
* Allows sharing and re-using query options in a type-safe way.
*
* The `queryKey` will be tagged with the type from `queryFn`.
*
Expand Down Expand Up @@ -117,7 +117,7 @@ export function queryOptions<
}

/**
* Allows to share and re-use query options in a type-safe way.
* Allows sharing and re-using query options in a type-safe way.
*
* The `queryKey` will be tagged with the type from `queryFn`.
*
Expand Down Expand Up @@ -149,7 +149,7 @@ export function queryOptions<
}

/**
* Allows to share and re-use query options in a type-safe way.
* Allows sharing and re-using query options in a type-safe way.
*
* The `queryKey` will be tagged with the type from `queryFn`.
*
Expand Down