Skip to content
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

Contradiction between usage examples in README and Redux docs #598

Closed
DenyVeyten opened this issue Feb 11, 2023 · 2 comments
Closed

Contradiction between usage examples in README and Redux docs #598

DenyVeyten opened this issue Feb 11, 2023 · 2 comments

Comments

@DenyVeyten
Copy link

Basic Usage examples https://github.com/reduxjs/reselect#basic-usage (selectSubtotal, selectTax) contradict guide in Redux docs https://redux.js.org/usage/deriving-data-selectors#balance-selector-usage

I think both should be updated to some middleground, explaining that memoization is good over heavy operations (e.g. iterating long lists), but is overhead for simple ones (e.g. small math calculations, iterating short lists).

@markerikson
Copy link
Contributor

markerikson commented Feb 11, 2023

Yeah, the README here is rather dated, but we've got a lot of other priorities and this really isn't on the list to update any time soon.

(Plus, there's always the issue with trying to show the basic techniques and mechanics, vs a "realistic" example that is more meaningful.)

aryaemami59 added a commit to aryaemami59/reselect that referenced this issue Nov 11, 2023
- Add documentation regarding new features.
- Redo `CodeSandbox` examples to align better with documentation. Solves reduxjs#598.
- Fix GitHub workflow badge URL reduxjs#628.
- Add instructions for `bun` and `pnpm`. Solves reduxjs#621.
- Fix minor type issues regarding `createStructuredSelector`. Solves reduxjs#499.
- `argsMemoize` and `argsMemoizeOptions` solve reduxjs#359.
- Remove `Redux` legacy patterns including `connect` and `switch` statements from docs.  Solves reduxjs#515.
- Replace legacy code patterns with modern syntax like `useSelector` and functional components.
- Implementation of `argsMemoize` solves reduxjs#376.
- Document order of execution in `Reselect`. Solves reduxjs#455.
- Add benchmarks to confirm the info inside the documentation.
- Add more type tests with `vitest`.
- Fix more hover preview issues with types.
@aryaemami59
Copy link
Contributor

This one has been resolved by #636.

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

4 participants