Fix documentation for useAtomCallback. #2150
Merged
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
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 e26313f:
|
stevemolitor
force-pushed
the
fix-callback-documentation
branch
from
6a819a5
to
eb4e045
Compare
See pmndrs#2149. The docs were for Jotai v1; update for v2. The change is that the callback function passed to `useAtomCallback` no longer returns a Promise; it just returns the atom value.
stevemolitor
force-pushed
the
fix-callback-documentation
branch
from
eb4e045
to
5328052
Compare
Just update the id in the docs. |
Done - e26313f I marked this PR as ready for review. |
dai-shi
approved these changes
Sep 27, 2023
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.
Update the
useAtomCallbackdocumentation.The docs were for Jotai v1; update for v2. The change is that the callback function passed to
useAtomCallbackno longer returns a Promise; it just returns the atom value.@dai-shi I forked the CodeSanbox example here, removing the
awaitthat is no longer needed. However I wasn't sure how to update the CodeSanbox link (id) in the docs.Related Issues or Discussions
Fixes #2149
Summary
Update the `useAtomCallback documentation for v2.
Check List
yarn run prettierfor formatting code and docs