Skip to content

Upgrade the typings dependency and update the docs #414

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Jul 23, 2020
Merged

Upgrade the typings dependency and update the docs #414

merged 5 commits into from
Jul 23, 2020

Conversation

erozak
Copy link
Contributor

@erozak erozak commented Jul 23, 2020

What:

  • Upgrade the typings dependency
  • Update the docs about the v3.3.0 changes of the wrapper option

Why:

  • The typings dependency doesn't match the APIs

Checklist:

  • Documentation updated
  • Ready to be merged

@codecov
Copy link

codecov bot commented Jul 23, 2020 •
edited
Loading

Codecov Report

Merging #414 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #414   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines           94        94           
  Branches        15        15           
=========================================
  Hits            94        94

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a873dd8...e88a323. Read the comment docs.

@erozak erozak changed the title Upgrade the typings dependency and docs Upgrade the typings dependency and update the docs Jul 23, 2020
mpeyper
mpeyper reviewed Jul 23, 2020
View reviewed changes
docs/usage/advanced-hooks.md Outdated

act(() => {
result.current.increment()
})

expect(result.current.count).toBe(2)

rerender({ step: -2 })
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that this is a relatively niche feature, I think we would be better off have the basic example just with a wrapper and then some text about using props with the wrapper before showing the more complex example.

Thoughts?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved the revision as a new section "Providing Props". It may help to show the use case about using initialProps and the rerender method with wrapper.

erozak added 2 commits July 23, 2020 16:15
@erozak
Revert "Update docs"
18008d5 
This reverts commit 482ee46.
@erozak
Update the docs
e88a323 
- Add new section "Providing props" under "Advanced Hooks/Context"
mpeyper
mpeyper approved these changes Jul 23, 2020
View reviewed changes
Copy link
Member

@mpeyper mpeyper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

@mpeyper mpeyper merged commit b7a2103 into testing-library:master Jul 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mpeyper mpeyper mpeyper approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@erozak @mpeyper