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

fix: Updates deprecated matchers info #378

Merged
merged 1 commit into from
Jun 11, 2021
Merged

Conversation

gnapse
Copy link
Member

@gnapse gnapse commented Jun 11, 2021

What:

Properly deprecates toHaveDescription in favour of toHaveAccessibleDescription. This PR also updates the README on other deprecation-related info (e.g. toBeEmpty was deprecated, but it was not reflected in the README).

While this gets reviewed and merged, I'll update the type definitions in DefinitelyTyped.

Pinging various reviewers, but only one is enough. Thanks in advance.

Checklist:

  • Documentation
  • Tests
  • Ready to be merged

@gnapse gnapse requested review from jgoz, eps1lon and a team June 11, 2021 15:17
@gnapse gnapse self-assigned this Jun 11, 2021
@codecov
Copy link

codecov bot commented Jun 11, 2021

Codecov Report

Merging #378 (abd617e) into main (87ffd2a) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##              main      #378   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           26        26           
  Lines          614       615    +1     
  Branches       225       225           
=========================================
+ Hits           614       615    +1     
Impacted Files Coverage Δ
src/to-have-description.js 100.00% <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 87ffd2a...abd617e. Read the comment docs.

@gnapse gnapse merged commit fc9ce6d into main Jun 11, 2021
@gnapse gnapse deleted the deprecated-matchers-update branch June 11, 2021 16:20
@github-actions
Copy link

🎉 This PR is included in version 5.14.1 🎉

The release is available on:

Your semantic-release bot 📦🚀


// See algoritm: https://www.w3.org/TR/accname-1.1/#mapping_additional_nd_description
export function toHaveDescription(htmlElement, checkWith) {
deprecate(
'toBeInTheDOM',
Copy link

Choose a reason for hiding this comment

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

Should be 'toHaveDescription'

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.

3 participants