From cc14525b474f324d35db9b6ae37fda80a5f6bc9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bal=C3=A1zs=20M=C3=A1t=C3=A9=20Petr=C3=B3?= Date: Thu, 17 Feb 2022 11:42:15 +0100 Subject: [PATCH] docs(codemod): update `Codemod` section The suggested text sounds better. :) Co-authored-by: Dominik Dorfmeister --- docs/src/pages/guides/migrating-to-react-query-4.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/src/pages/guides/migrating-to-react-query-4.md b/docs/src/pages/guides/migrating-to-react-query-4.md index 93b273b34f..6c28599c3c 100644 --- a/docs/src/pages/guides/migrating-to-react-query-4.md +++ b/docs/src/pages/guides/migrating-to-react-query-4.md @@ -18,7 +18,13 @@ To streamline all apis, we've decided to make all keys Arrays only: + useQuery(['todos'], fetchTodos) ``` -To make this migration easier we decided to deliver a codemod. You can easily apply it by using one (or both) of the following commands. +#### Codemod + +To make this migration easier, we decided to deliver a codemod. + +> The codemod is a best efforts attempt to help you migrate the breaking change. Please review the generated code thoroughly! Also, there are edge cases that cannot be found by the code mod, so please keep an eye on the log output. + +You can easily apply it by using one (or both) of the following commands: If you want to run it against `.js` or `.jsx` files, please use the command below: