Suspense feature description ambiguity between release note and React API reference
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
On actual (v18.2.0) React API reference page (https://reactjs.org/docs/react-api.html) is written:
Today, lazy loading components is the only use case supported by <React.Suspense>:
and
In the future we plan to let Suspense handle more scenarios such as data fetching. You can read about this in our roadmap.
(also interesting that this link referring into React 16 Roadmap while we have 18 released.)
At the same time React 18 Release Page says that:
In React 18, you can start using Suspense for data fetching in opinionated frameworks like Relay, Next.js, Hydrogen, or Remix.
and looks like 'Suspense for data fetching' can be used and information in React API reference in outdated?
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
Compare the React API reference at reactjs.org/docs/react-api.html with the React 18 release page section on Suspense in data frameworks. Check whether the API reference and its React 16 roadmap link accurately describe the supported use cases, then update the conflicting wording and verify both pages remain consistent.
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
- 38/100