Add note about element reference equality bailout in Optimizations, maybe Reconciliation?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
Could the bailout described here be added to the React documentation in the Optimizations or reconciliation page (and maybe a note in the other)?
Currently this functionality seems to be undocumented, which means the React docs don't properly match the public API right now. The closest thing is the second paragraph Avoid Reconciliation here. This at best only might imply the functionality. Would be great to have it explicit.
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 React documentation's Optimizations page and the reconciliation page, especially the existing “Avoid Reconciliation” section. Read the linked article for the element reference equality bailout and determine where the explanation fits best. Done means the behavior is explicitly documented on one page, with a cross-reference or note on the other if appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100