docs: minor 3.9 docs copyedits #11636
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Meschreiber
commented
Mar 1, 2024
| @@ -1,6 +1,6 @@ | |||
| --- | |||
| title: Suspense | |||
| description: Using React 18 Suspense features with Apollo Client | |||
| description: Use React 18 Suspense features with Apollo Client | |||
There was a problem hiding this comment.
This matches the tense of the other pages in the Fetching section.
Meschreiber
commented
Mar 1, 2024
| @@ -70,13 +70,21 @@ function Dog({ id }: DogProps) { | |||
| } | |||
| ``` | |||
|
|
|||
| > **Note:** This example manually defines TypeScript interfaces for `Data` and `Variables` as well as the type for `GET_DOG_QUERY` using `TypedDocumentNode`. [GraphQL Code Generator](https://www.the-guild.dev/graphql/codegen) is a popular tool that creates these type definitions automatically for you. See the reference on [Using TypeScript](../development-testing/static-typing) for more information on integrating GraphQL Code Generator with Apollo Client. | |||
| <Note> | |||
There was a problem hiding this comment.
Since 3.9 docs introduced the component, I figured we should standardize at least throughout this page.
size-limit report 📦
|
Meschreiber
commented
Mar 1, 2024
| We begin fetching our `GET_DOG_QUERY` by calling the `loadDog` function inside of the `onChange` handler function when a dog is selected. Once the network request is initiated, the `queryRef` is no longer `null` which renders the `Dog` component. In the `Dog` component, `useReadQuery` suspends the component while the network request finishes, then returns `data` to the component. As a result of this change, we've also eliminated the need to track the selected dog `id` in component state! | ||
| We begin fetching our `GET_DOG_QUERY` by calling the `loadDog` function inside of the `onChange` handler function when a dog is selected. Once the network request is initiated, the `queryRef` is no longer `null`, rendering the `Dog` component. | ||
|
|
||
| `useReadQuery` suspends the `Dog` component while the network request finishes, then returns `data` to the component. As a result of this change, we've also eliminated the need to track the selected dog `id` in component state. |
There was a problem hiding this comment.
Just breaking up a longer paragraph.
Meschreiber
commented
Mar 1, 2024
|
|
||
| </ExperimentalFeature> | ||
|
|
||
| Starting with Apollo Client `3.9.0`, queries can be initiated outside of React. This allows your app to begin fetching data _before_ React renders your components, and can provide performance benefits. | ||
| Starting with Apollo Client `3.9.0`, queries can be initiated outside of React. This allows your app to begin fetching data before React renders your components, and can provide performance benefits. |
There was a problem hiding this comment.
Due to feedback from our docs consultants, we're pulling back on text treatment and reserving italics for new terms and bold for UI elements. (See Text formatting in Style guide.)
✅ Deploy Preview for apollo-client-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
jerelmiller
approved these changes
Mar 5, 2024
There was a problem hiding this comment.
Thanks so much for going through this!
And yes, those quoted strings are important to avoid confusion on how to define it. The properties are declared as:
{
"queryManager.getDocumentInfo": 1000
}Rather than something like:
{
queryManager: {
getDocumentInfo: 1000
}
}Those quotes help provide a hint at this structure.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Very minor copyedits on 3.9 docs—mostly breaking up long sentences and paragraphs and making things more concise. (Sorry it took me so long to get to them!)
As a side note, I was able to review the Cache Sizes doc earlier, but am just noticing the double quotations on some of the cache options. Is this intended?