Skip to content

Clarify captures documentation #65

@milesfrain

Description

@milesfrain

Some proposals:

  1. Add a few words about captures to this section:
    https://github.com/thomashoneyman/purescript-halogen-hooks/blob/main/docs/01-Hooks-At-A-Glance.md#the-effect-hook

  2. Change the language here to clarify that captures is 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 like Halogen.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

  3. Add a note about how captures is necessary in the useTickEffect docs 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    document meImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions