From ffe214d7098bd35eb52584129051fc6ecf456197 Mon Sep 17 00:00:00 2001
From: piq9117 <piq9117@gmail.com>
Date: Fri, 28 Feb 2020 03:09:19 -0600
Subject: [PATCH] Documentation: useAff

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

diff --git a/src/React/Basic/Hooks/Aff.purs b/src/React/Basic/Hooks/Aff.purs
index 63e81eb..6553e01 100644
--- a/src/React/Basic/Hooks/Aff.purs
+++ b/src/React/Basic/Hooks/Aff.purs
@@ -17,6 +17,10 @@ derive instance ntUseAff :: Newtype (UseAff key a hooks) _
 type Result a
   = Maybe (Either Error a)
 
+-- | `useAff` is used for asynchronous effects or `Aff`. The asynchronous effect
+-- | is re-run whenever the key changes. If another `Aff` runs when the key
+-- | changes before the previous async resolves, it will cancel the previous in
+-- | flight async effect.
 useAff ::
   forall key a.
   Eq key =>