docs: clarify that update() syncs the tree, not force re-render - #2616
Open
Hashim1999164 wants to merge 1 commit into
Open
docs: clarify that update() syncs the tree, not force re-render#2616Hashim1999164 wants to merge 1 commit into
Hashim1999164 wants to merge 1 commit into
Conversation
Align ReactWrapper and ShallowWrapper JSDoc with the API docs so IDE tooltips match the documented behavior for issue enzymejs#2494.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
ReactWrapper#updateandShallowWrapper#updateJSDoc with the API docs.update()only syncs Enzyme's tree snapshot.wrapper.setProps({}), matching the existing docs.Fixes #2494
Test plan
docs/api/ReactWrapper/update.mdanddocs/api/ShallowWrapper/update.mdwrapper.update()after install from this branch