Skip to content

The docs for new changes in v5 are a bit confusing #747

Open

Description

@phoneticallySAARTHaK

I faced some issues while reading and understanding the docs for the new changes in reselect v5, and some additional clarity would greatly help understanding what a particular thing does.

  • The description for createSelectorOptions in createSelector Reference isn't descriptive enough:
    The docs for each property are on the createSelectorCreator page. While it is common sense(?) that what the options param in createSelector is, A link or mention to createSelectorCreator should be there.
    Similarly, inputStabilityCheck on the createSelectorCreator reference has no mention of this being a Development-Only Stability Check
  • The documentation needed to understand caching is all over the place:
    To understand and configure caching/memoization, there's no single document, one would have to check multiple pages, and with so many similar terms (memoize, argsMemoize, equalityCheck, resultEqualityCheck) it gets really confusing. A guide like How Does Reselect Work? for caching would be really helpful.

This may sound like nit-picking.. but it took me a while to fully understand it.

Also, the --ifm-menu-color-active(#ecf4f9) on --ifm-menu-color-background-hover(#0000000d) has a really bad contrast ratio, same issue in dark mode as well.

Activity

  1. Gudahtt commented on Aug 8, 2025

    @Gudahtt

    Strongly agreed!

    Calling the createSelectorOptions entry "not descriptive enough" is an understatement. This is the sole description right now:

    An optional options object that allows for further customization per selector.

    No information about what properties the object has, what further customization is possible, etc.

    I came here expecting to have to dig into the codebase to find out what this does. I didn't realize until seeing this issue that the object was the same as is described on the createSelectorCreator page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions