react.dev icon indicating copy to clipboard operation
react.dev copied to clipboard

Clarified 'one level deep' in hydration mismatch error documentation

Open mudassir-jmi opened this issue 1 year ago • 2 comments

This pull request aims to enhance the React documentation regarding suppressing hydration mismatch errors by providing a clear definition of the term "one level deep."

Changes Made:

Updated the documentation under the "Suppressing unavoidable hydration mismatch errors" section to clarify that: The suppression of hydration mismatch warnings only applies to the immediate children of the element with the suppressHydrationWarning={true} attribute. This means that any nested children beyond the immediate level will not benefit from this suppression.

Rationale:

The current documentation may cause confusion for developers regarding the scope of the suppressHydrationWarning attribute. Providing this clarification will help users better understand how to use this feature effectively and avoid potential pitfalls in their applications. By making this change, we hope to improve the user experience for developers working with React, allowing them to implement hydration warnings more confidently and accurately.

mudassir-jmi avatar Oct 08 '24 05:10 mudassir-jmi

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
19-react-dev ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 8, 2024 5:33am
react-dev ✅ Ready (Inspect) Visit Preview Oct 8, 2024 5:33am

vercel[bot] avatar Oct 08 '24 05:10 vercel[bot]

Size changes

📦 Next.js Bundle Analysis for react-dev

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

github-actions[bot] avatar Oct 08 '24 05:10 github-actions[bot]