on develop help sign in
Merge pull request #322 from alexfmpe/clarify-view-docs

Add missing details to documentation of 'dyn'

commit4c0e8c726265c447ccecdd756c415abab09687d8 authorJohn Ericson <John.Ericson@Obsidian.Systems> dateThu 12 Dec 2019, 17:01 (7 years ago) parenta579bf79888d65
1 file changed+3−1
reflex-dom-core/src/Reflex/Dom/Widget/Basic.hs+3−1
reflex-dom-core/src/Reflex/Dom/Widget/Basic.hs+3−1
@@ -146,7 +146,9 @@ button t = do
146146
147147--TODO: Should this be renamed to 'widgetView' for consistency with 'widgetHold'?
148148-- | Given a Dynamic of widget-creating actions, create a widget that is recreated whenever the Dynamic updates.
149−-- The returned Event of widget results occurs when the Dynamic does.
149+-- The returned Event occurs whenever the child widget is updated, which is
150+-- at post-build in addition to the times at which the input Dynamic is
151+-- updated, and its value is the result of running the widget.
150152-- Note: Often, the type @a@ is an 'Event', in which case the return value is an Event-of-Events that would typically be flattened (via 'switchHold').
151153dyn :: (Adjustable t m, NotReady t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
152154dyn = networkView