Reflex.Network: improve haddocks

reflex-frp / reflex

Interactive programs without callbacks or side-effects. Functional Reactive Programming (FRP) uses composable events and time-varying values to describe interactive systems as pure functions. Just like other pure functional code, functional reactive code is easier to get right on the first try, maintain, and reuse.

https://reflex-frp.org

BSD 3-Clause "New" or "Revised" License

1.07k stars 149 forks source link

Reflex.Network: improve haddocks #500

Closed endgame closed 3 months ago

endgame commented 3 months ago

Replace reference to deprecated function with its replacement
Normalise comment formatting
Suggest how to flatten the result of networkHold

alexfmpe commented 3 months ago

*promptly ? That doesn't sound like something we want to recommend outside of very specific situations. I can only remember using it once in 5+ years

endgame commented 3 months ago

I haven't used networkHold much at all, but the previous version of the docs referenced a ...Promptly function. I think otherwise you miss any event firings from the frame that swaps the network in, and that's usually something I want (to capture).

ali-abrar commented 3 months ago

Agree we should rethink the use of promptly here, but that isn't new to this PR.