docs: Elaborate on usage of queries #1133
Merged
Conversation
This file contains hidden or 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
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/tannerlinsley/react-query/ko08n62yf |
|
Please make this same PR to the next branch? |
|
Same PR made on next branch. Thanks for merging! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
There's a bit of a learning curve to react-query, especially when it comes to understanding the difference between queries and mutations and how to use react-query for a POST method.
I've added some explanation to the docs based on the discussion in #801
Currently, the algolia search for "post" leads to results from the "Invalidation from Mutations" document which might not exactly be relevant for someone just trying to make a basic POST call.
This change will hopefully make the "Queries" section show up in results for "post" too since a simple query might be ideal to use when the POST function isn't modifying server data. The docs currently don't mention clearly that queries can work fine for POST calls.
Please feel free to edit the words to a better-suited language if possible but it'd really be great if the docs explicitly mentioned that queries can be used with POST calls.