Docs - extend detail for Queries & endpoints
#1074
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 4b629cb:
|
|
FYI the netlify docs won't currently build for this, but after #1073 they should be fine |
docs/api/rtk-query/createApi.mdx
Outdated
|
|
||
| Defaults to: | ||
|
|
||
| ```ts no-transpile |
There was a problem hiding this comment.
❓ Do we really need to copy the entire implementation here? Seems like a written description of behavior would be sufficient.
There was a problem hiding this comment.
Hmm I agree. A written description would certainly cover it.
However, can you think of a theoretical example for a custom version of serializeQueryArgs someone might want to use rather than the default? If so, I think that would be beneficial as a snippet
There was a problem hiding this comment.
FYI I've replaced this with a written description, but I can't think of a realistic example someone would use to override it
- Add brief descriptions to the query hooks - Add brief descriptions to the query hook options - Add brief tip about `skipToken` on the `Conditional Fetching` page - Shift 'Anatomy of an endpoint' into a larger section at end of page - Flesh out property details & examples in 'anatomy of an endpoint' - Miscellaneous order re-arranging - Update `defaultSerializeQueryArgs` shown in docs as per actual version - Update links to specific sections of endpoint anatomy where applicable
replace with written explanation of behaviour
Shrugsy
force-pushed
the
docs/extend-detail-for-queries-and-endpoints
branch
from
dc7ceea
to
405cd43
Compare
|
Deploy Preview for redux-starter-kit-docs ready! Built with commit 4b629cb https://deploy-preview-1074--redux-starter-kit-docs.netlify.app |
|
@markerikson following on from #964 (comment) I've removed the 'query hook return types' & 'mutation hook trigger type' codeblocks, and instead replaced them with written descriptions/bullet points like so: https://deploy-preview-1074--redux-starter-kit-docs.netlify.app/usage/rtk-query/queries#frequently-used-query-hook-return-values Let me know if you think any of them probably wouldn't "frequently used" enough to warrant being there, or if you have any other recommendations |
|
@akursat please let me know if you have any opinions on these changes, following your comment: #964 (comment) Note that both the query & mutation endpoint definitions are proposed to move to |
|
Do it. |
Related to #964
skipTokenon theConditional FetchingpagedefaultSerializeQueryArgsshown in docs as per actual version