-
-
Notifications
You must be signed in to change notification settings - Fork 12
Description
Some proposals:
-
Add a few words about
capturesto this section:
https://github.com/thomashoneyman/purescript-halogen-hooks/blob/main/docs/01-Hooks-At-A-Glance.md#the-effect-hook -
Change the language here to clarify that
capturesis not an optional performance enhancement, but that it is required. (obvious in hindsight when looking at the type signature, but this might still trip-up future readers too).
https://pursuit.purescript.org/packages/purescript-halogen-hooks/0.4.3/docs/Halogen.Hooks#v:captures
When I originally read "Used to improve performance", I assumed this worked likeHalogen.HTML.memoized, where you can optionally choose to use it. https://pursuit.purescript.org/packages/purescript-halogen/5.0.0/docs/Halogen.HTML#v:memoized -
Add a note about how
capturesis necessary in theuseTickEffectdocs too. https://pursuit.purescript.org/packages/purescript-halogen-hooks/0.4.3/docs/Halogen.Hooks#v:useTickEffect
Also, I see "array" mentioned here a lot, but the first argument looks like a record.