Skip to content

Commit 697bd35

Browse files
committed
fix up incorrect canonical references
1 parent 8d6e527 commit 697bd35

File tree

6 files changed

+8
-7
lines changed

6 files changed

+8
-7
lines changed

.circleci/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ jobs:
3636
- checkout
3737
- run: npm version
3838
- run: npm ci
39+
- run: npm run docmodel
3940
- run: npm run build
4041
- run: npm run lint
4142

docs/source/api/core/ApolloClient.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ For more information on the `defaultOptions` object, see the [Default Options](#
4545
## Types
4646

4747
<InterfaceDetails
48-
canonicalReference="@apollo/client!ApolloClientOptions:interface"
48+
canonicalReference="@apollo/client!ApolloClient.Options:interface"
4949
headingLevel={3}
5050
customPropertyOrder={[
5151
"cache",
@@ -58,7 +58,7 @@ customPropertyOrder={[
5858
]}
5959
/>
6060

61-
<InterfaceDetails canonicalReference="@apollo/client!DefaultOptions:interface" headingLevel={3} />
61+
<InterfaceDetails canonicalReference="@apollo/client!ApolloClient.DefaultOptions:interface" headingLevel={3} />
6262

6363
##### Example `defaultOptions` object
6464

docs/source/api/react/useLazyQuery.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ description: Apollo Client API reference
2222
<ManualTupleItem
2323
name="result"
2424
type="QueryResult<TData, TVariables>"
25-
canonicalReference="@apollo/client!QueryResult:interface"
25+
canonicalReference="@apollo/client!useLazyQuery.DocumentationTypes.useLazyQuery.Result:interface"
2626
>
2727
The result of the query. See the `useQuery` hook for more details.
2828
</ManualTupleItem>

docs/source/api/react/useMutation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ description: Apollo Client API reference
4545
<ManualTupleItem
4646
name="result"
4747
type="MutationResult<TData>"
48-
canonicalReference="@apollo/client!MutationResult:interface"
48+
canonicalReference="@apollo/client!useMutation.Result:interface"
4949
idPrefix="usemutation-result"
5050
>
5151
The result of the mutation.

docs/source/data/queries.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -528,13 +528,13 @@ Most calls to `useQuery` can omit the majority of these options, but it's useful
528528
529529
The `useQuery` hook accepts the following options:
530530
531-
<PropertySignatureTable canonicalReference="@apollo/client!useQuery.DocumentationTypes.Options:interface" idPrefix="queryhookoptions-interface" />
531+
<PropertySignatureTable canonicalReference="@apollo/client!useQuery.DocumentationTypes.useQuery.Options:interface" idPrefix="queryhookoptions-interface" />
532532
533533
### Result
534534
535535
After being called, the `useQuery` hook returns a result object with the following properties. This object contains your query result, plus some helpful functions for refetching, dynamic polling, and pagination.
536536
537-
<PropertySignatureTable canonicalReference="@apollo/client!useQuery.DocumentationTypes.Result:interface" idPrefix="queryresult-interface" />
537+
<PropertySignatureTable canonicalReference="@apollo/client!useQuery.DocumentationTypes.useQuery.Result:interface" idPrefix="queryresult-interface" />
538538
539539
## Next steps
540540

docs/source/data/subscriptions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -518,7 +518,7 @@ In the example above, we pass three options to `subscribeToMore`:
518518

519519
The `useSubscription` Hook accepts the following options:
520520

521-
<PropertySignatureTable canonicalReference="@apollo/client!useSubscription.DocumentationTypes.Result:interface" idPrefix="subscriptionhookoptions-interface" />
521+
<PropertySignatureTable canonicalReference="@apollo/client!useSubscription.DocumentationTypes.useSubscription.Result:interface" idPrefix="subscriptionhookoptions-interface" />
522522

523523
### Result
524524

0 commit comments

Comments
 (0)