Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentataion: mutaitonHookOptions.ignoreResults requires additional clarification #11950

Open
ksdc-grantw opened this issue Jul 11, 2024 · 1 comment
Labels
📚 good-first-issue Issues that are suitable for first-time contributors. 📝 documentation

Comments

@ksdc-grantw
Copy link

The documentation for the UseMutation Option ignoreResults (see here) only states that the "data property is not updated with the mutation's result".

It does not indicate that the loading state of the requests is also not updated. Please can you update the docs to include this clarification.

Thanks,
Grant

@phryneas
Copy link
Member

That's a good callout - in fact, ignoreResults will cause the hook to ignore all information about the running mutation. Do you want to open a PR against our documentation? It would be greatly appreciated.

@phryneas phryneas added 📝 documentation 📚 good-first-issue Issues that are suitable for first-time contributors. labels Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 good-first-issue Issues that are suitable for first-time contributors. 📝 documentation
Projects
None yet
Development

No branches or pull requests

2 participants