Add doc comment

purescript-halogen · Mar 20, 2019 · e0532a9 · e0532a9
1 parent 9a7e7cb
commit e0532a9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/Halogen/VDom/Types.purs b/src/Halogen/VDom/Types.purs
@@ -40,6 +40,10 @@ instance bifunctorVDom ∷ Bifunctor VDom where
   bimap f g (Grafted a) = Grafted (bimap f g a)
   bimap f g a = Grafted (graft (Graft f g a))
 
+-- | Replaces "widgets" in the `VDom` with the ability to turn them into other
+-- | `VDom` nodes.
+-- |
+-- | Using this function will fuse any `Graft`s present in the `VDom`.
 renderWidget ∷ ∀ a w x. (w → VDom a x) → VDom a w → VDom a x
 renderWidget f = case _ of
   Text a → Text a