document assertReducerSanity behavior #1633
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It is not clear from the documentation that it is insufficient to merely avoid ever passing in `undefined` as state by using initial state. `assertReducerSanity` will test that your reducer does the right thing when passed `undefined`, even if you never intend for it to be called this way. This documentation change makes that behavior clearer, in the hopes of saving new users from needless frustration.
|
Yeah. Ideally we should also explain why this is the case. I like your changes but please consider the broader picture—I’d be happy if you could take tweak Thanks! |
|
We can add that in another PR, I suppose. Let's get this in for now. Thanks, @ruggeri! |
seantcoyote
pushed a commit
to seantcoyote/redux
that referenced
this pull request
Jan 14, 2018
It is not clear from the documentation that it is insufficient to merely avoid ever passing in `undefined` as state by using initial state. `assertReducerSanity` will test that your reducer does the right thing when passed `undefined`, even if you never intend for it to be called this way. This documentation change makes that behavior clearer, in the hopes of saving new users from needless frustration.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is not clear from the documentation that it is insufficient to merely avoid ever passing in
undefinedas state by using initial state.assertReducerSanitywill test that your reducer does the right thing when passedundefined, even if you never intend for it to be called this way.This documentation change makes that behavior clearer, in the hopes of saving new users from needless frustration. It was very confusing to see my reducer passed undefined even though I never intended it to be used that way. I did not suspect
combineReducerswould do this.Hope this helps!