fix docs typos #1836
fix docs typos #1836
Conversation
|
|
|
||
| ```tsx | ||
| import createFetchClient from "openapi-fetch"; | ||
| import createClient from "openapi-react-query"; | ||
| import type { paths } from "./my-openapi-3-schema"; // generated by openapi-typescript |
There was a problem hiding this comment.
We use double quotes in this repository and I think we should keep documentation with the same rules (default biome ones)
There was a problem hiding this comment.
Updated, thanks. My autoformat on save was the culprit, lol.
| @@ -25,11 +25,11 @@ Next, generate TypeScript types from your OpenAPI schema using openapi-typescrip | |||
| npx openapi-typescript ./path/to/api/v1.yaml -o ./src/lib/api/v1.d.ts | |||
| ``` | |||
|
|
|||
| > ⚠️ Be sure to <a href="https://redocly.com/docs/cli/commands/lint/" target="_blank" rel="noopener noreferrer">validate your schemas</a>! openapi-typescript will err on invalid schemas. | |||
| > ⚠️ Be sure to <a href="https://redocly.com/docs/cli/commands/lint/" target="_blank" rel="noopener noreferrer">validate your schemas</a>! openapi-typescript will error on invalid schemas. | |||
There was a problem hiding this comment.
“err“ is correct; that is a verb. “Error” is a noun, so this isn’t correct.
However, this sentence only applies to 6.x, not 7.x (since that will validate). So we could just remove this altogether.
| @@ -42,25 +42,25 @@ const fetchClient = createFetchClient<paths>({ | |||
| const $api = createClient(fetchClient); | |||
|
|
|||
| const MyComponent = () => { | |||
| const { data, error, isLoading } = $api.useQuery( | |||
| const { data, error, isPending } = $api.useQuery( | |||
There was a problem hiding this comment.
| const { data, error, isPending } = $api.useQuery( | |
| const { data, error, isLoading } = $api.useQuery( |
? I’m confused; this should be isLoading, shouldn’t it? Why the change?
There was a problem hiding this comment.
You have v5 as a peer dependency.
There was a problem hiding this comment.
Ah thanks for explaining! I missed that. I think we have some other docs out-of-date, then. This is good for now!
Changes
Just fixing some docs typos.
How to Review
NA
Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)