docs(renderHook): remove references to error and all from renderHook API #963
Conversation
This file contains 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
mdjastrzebski
requested changes
Apr 28, 2022
website/docs/API.md
Outdated
| all: Array<any> | ||
| current: any, | ||
| error: Error | ||
| current: any |
There was a problem hiding this comment.
Since RenderHookResult accepts generic Result parameter we should use it instead of any here.
There was a problem hiding this comment.
I hope my changes align with what you were thinking for this.
mpeyper
commented
May 1, 2022
| A React component to wrap the test component in when rendering. This is usually used to add context providers from `React.createContext` for the hook to access with `useContext`. `initialProps` and props subsequently set by `rerender` will be provided to the wrapper. | ||
| A React component to wrap the test component in when rendering. This is usually used to add context providers from `React.createContext` for the hook to access with `useContext`. |
There was a problem hiding this comment.
While fixing the types, I also noticed that this is not true for your implementation either.
mdjastrzebski
approved these changes
May 2, 2022
AugustinLF
approved these changes
May 3, 2022
Closed
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.
Summary
Correct the
renderHookAPI docs asresult.errorandresult.allwere not included in the new RTL version ofrenderHook. I also fixed a typo and renamed a test example to better describe what it is showing (both in the same file).Test plan
No testing is required other than reviewing the documentation changes.