🚫** (Warns in development) is open to interpretation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
My colleagues and I were discussing this section of the docs and got a bit confused:
https://reactjs.org/docs/concurrent-mode-adoption.html#feature-comparison
It was not 100% clear whether 🚫** → Warns in development means
- works, may be buggy, warns in development
or - does not work, also warns in development.
Both interpretations can be explained logically. The first one can be true because the footer note does explicitly say does not work and we're still in 16.x, which assumes no breaking changs. The second interpretation comes from the presence of 🚫.
I'm wondering if the docs could be improved by replacing 🚫* and 🚫** with distinct emojis (e.g. ⚠️, ⛔️, 🚨, 🤞, ✳️, 🆗, ❇️, etc.). Each emoji can be present in a footnote, including ✅ and 🚫.
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
Start with the Feature Comparison section at the linked concurrent-mode-adoption.html URL and inspect the 🚫* and 🚫** legend, footnotes, and screenshot. Clarify the distinction between supported-but-warning behavior and unsupported behavior, then verify that the revised symbols and explanations render clearly in the documentation.
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