[Suggestion]: Define what "one level deep" means in the definition for suppressHydrationWarning
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
Summary
In the docs for "Suppressing unavoidable hydration mismatch errors" (https://react.dev/reference/react-dom/hydrate#suppressing-unavoidable-hydration-mismatch-errors), it would be helpful to define what "one level deep" means when the docs say: "This only works one level deep, and is intended to be an escape hatch."
Page
https://react.dev/reference/react-dom/hydrate#suppressing-unavoidable-hydration-mismatch-errors
Details
Does one level deep mean all immediate children but nothing further down the tree, or something else? Defining this in the docs would be helpful. Thanks!
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 “Suppressing unavoidable hydration mismatch errors” section at the linked react.dev hydrate page and review the wording around “one level deep.” Clarify whether this refers to immediate children only or another scope, and update the documentation so the meaning is unambiguous.
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
- Clearly specified
- Newbie friendliness
- 55/100