From a4022df8c395b4cfc5df7d91394abaa9d95f4a20 Mon Sep 17 00:00:00 2001
From: Peter Murphy <26548438+ptrfrncsmrph@users.noreply.github.com>
Date: Fri, 25 Dec 2020 19:18:42 -0500
Subject: [PATCH] Correct useLayoutEffect documentation

---
 src/React/Basic/Hooks.purs | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/React/Basic/Hooks.purs b/src/React/Basic/Hooks.purs
index 3c1af09..c3a3df8 100644
--- a/src/React/Basic/Hooks.purs
+++ b/src/React/Basic/Hooks.purs
@@ -206,8 +206,10 @@ useEffectAlways effect = unsafeHook (runEffectFn1 useEffectAlways_ effect)
 
 foreign import data UseEffect :: Type -> Type -> Type
 
--- | Like `useEffect`, but the effect is performed on every render. Prefer `useEffect`
--- | with a proper dependency list whenever possible!
+-- | Like `useEffect`, but the effect is performed synchronously after the browser has
+-- | calculated layout. Useful for reading properties from the DOM that are not available
+-- | before layout, such as element sizes and positions. Prefer `useEffect` whenever
+-- | possible to avoid blocking browser painting.
 useLayoutEffect ::
   forall deps.
   Eq deps =>