[Typo]: change info about startTransition, now can be used with async func
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
Summary
Documentation advises against using async functions inside startTransition. However, in the newest changelogs, that has changed, and we can now easily use async functions inside startTransition. Perhaps I misunderstood it.
Page
https://react.dev/reference/react/startTransition
Details
If you read the documentation on react-dev, you can find information about startTransition. However, when you check the changelog on the react GitHub, you will find information about adding an option to use async functions at.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the startTransition reference page on react.dev and compare its guidance about async functions with the referenced CHANGELOG-canary.md entry for October 5, 2023. Confirm whether the documentation is outdated, then update the page so its guidance matches the current behavior and changelog; the work is done when the async-function advice is accurate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100