on develop help sign in
Merge pull request #88 from eskimor/incremental-doc-improvement

Clarify difference between Incremental and Dynamic

commit9e6b9e3d7ac5a0b9d711b2514c0c51ed0c5533a5 authorRyan Trinkle <ryan.trinkle@gmail.com> dateWed 1 Feb 2017, 16:22 (10 years ago) parentdc90dd9d1d7648
1 file changed+4−4
src/Reflex/Class.hs+4−4
src/Reflex/Class.hs+4−4
@@ -216,10 +216,10 @@ class ( MonadHold t (PushM t)
216216 -- 'Event', with a rule that the 'Behavior' will change if and only if the
217217 -- 'Event' fires.
218218 data Dynamic t :: * -> *
219− -- | A container for a value that can change over time and allows
220− -- notifications on changes. Basically a combination of a 'Behavior' and an
221− -- 'Event', with a rule that the 'Behavior' will change if and only if the
222− -- 'Event' fires.
219+ -- | An 'Incremental' is a more general form of a 'Dynamic'.
220+ -- Instead of always fully replacing the value, only parts of it can be patched.
221+ -- This is only needed for performance critical code via `mergeIncremental` to make small
222+ -- changes to large values.
223223 data Incremental t :: * -> *
224224 -- | A monad for doing complex push-based calculations efficiently
225225 type PushM t :: * -> *