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: corrects deprecation warning for waitForDomChange #478

Merged
merged 1 commit into from
Mar 13, 2020
Merged

docs: corrects deprecation warning for waitForDomChange #478

merged 1 commit into from
Mar 13, 2020

Conversation

egilsster
Copy link
Contributor

@egilsster egilsster commented Mar 13, 2020

What:

If you are migrating from waitForDomChanges, it suggests using wait instead, which is also deprecated and it suggests waitFor. The link in this particular warning is linked to waitFor.

`waitForElement` has been deprecated. Use a `find*` query ...
`waitForDomChange` has been deprecated. Use `wait` instead ...

but then it says wait is also deprecated:

`wait` has been deprecated and replaced by `waitFor` instead. In most cases you should be able to find/replace `wait` with `waitFor`.

Why:

☝️

How:

Updated deprecation warning string with the correct suggestion

Checklist:

  • Documentation added to the
    docs site
  • I've prepared a PR for types targeting
    DefinitelyTyped N/A
  • Tests
  • Ready to be merged

@codesandbox-ci
Copy link

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@codecov
Copy link

codecov bot commented Mar 13, 2020

Codecov Report

Merging #478 into master will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #478   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           22        22           
  Lines          423       423           
  Branches       101       101           
=========================================
  Hits           423       423           
Impacted Files Coverage Δ
src/wait-for-dom-change.js 100.00% <ø> (ø)

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 98e5bb3...d8d053d. Read the comment docs.

@egilsster egilsster marked this pull request as ready for review March 13, 2020 09:48
Copy link
Member

@kentcdodds kentcdodds left a comment

Choose a reason for hiding this comment

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

Thank you! Sorry about the confusion.

@kentcdodds kentcdodds merged commit 9768a2b into testing-library:master Mar 13, 2020
@kentcdodds
Copy link
Member

@all-contributors please add @egilsster for code

@allcontributors
Copy link
Contributor

@kentcdodds

I've put up a pull request to add @egilsster! 🎉

@egilsster egilsster deleted the correct_deprecation_warn branch March 13, 2020 13:32
@kentcdodds
Copy link
Member

🎉 This PR is included in version 7.0.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants