Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
phoneticallySAARTHaK opened this issue May 11, 2025 · 0 comments
Open

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

phoneticallySAARTHaK opened this issue May 11, 2025 · 0 comments

Comments

@phoneticallySAARTHaK
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant