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

[Docs] mount/shallow: update: Bring the docs up to date with the implementation #2552

Merged
merged 1 commit into from
Jan 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/api/ReactWrapper/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
Syncs the enzyme component tree snapshot with the react component tree. Useful to run before checking the render output if something external
may be updating the state of the component somewhere.

NOTE: can only be called on a wrapper instance that is also the root instance.
NOTE: only update the Enzyme's representation of rendered tree.
NOTE: no matter what instance this is called on, it will always update the root.

NOTE: only updates Enzyme's representation of rendered tree.

NOTE: this does not force a re-render. Use `wrapper.setProps({})` to force a re-render.


Expand Down
6 changes: 4 additions & 2 deletions docs/api/ShallowWrapper/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
Syncs the enzyme component tree snapshot with the react component tree. Useful to run before checking the render output if something external
may be updating the state of the component somewhere.

NOTE: can only be called on a wrapper instance that is also the root instance.
NOTE: only update the Enzyme's representation of rendered tree.
NOTE: no matter what instance this is called on, it will always update the root.

NOTE: only updates Enzyme's representation of rendered tree.

NOTE: this does not force a re-render. Use `wrapper.setProps({})` to force a re-render.


Expand Down