Skip to content

Update README.md #221

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

Merged
merged 3 commits into from
Nov 14, 2018
Merged

Update README.md #221

merged 3 commits into from
Nov 14, 2018

Conversation

NoriSte
Copy link
Contributor

@NoriSte NoriSte commented Nov 14, 2018

I've aligned the documented signature of some functions in the README

I made that because I got confused at the beginning and I took some time to understand that they were just some examples (and not a real documentation).

  • Documentation
  • Ready to be merged

Some functions missed the `options` argument, I got confused at the beginning and I moved back and forth from `dom-testing-library` and `react-testing-library` to understand the differences...
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.

Thanks, but I don't think those options are correct. Could you check with the type definitions/source code please?

Added the complete typings to the description except for `ignore = 'script, style',`. I skipped the `ignore` option to be aligned with the `dom-testing-library`
@NoriSte
Copy link
Contributor Author

NoriSte commented Nov 14, 2018

Done, I followed the same signing of the dom-testing-library readme. I avoided adding the types because the docs use the function as h4 so too long title risks to make them unreadable.

Let me know what do you think or if you prefer I think better at changing the readme to make it "better"

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.

The options were too long to be in the header, so I pulled them out.

Thanks for your help!

@kentcdodds kentcdodds merged commit 169434f into testing-library:master Nov 14, 2018
@kentcdodds
Copy link
Member

🎉 This PR is included in version 5.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

lucbpz pushed a commit to lucbpz/react-testing-library that referenced this pull request Jul 26, 2020
…with-text

fix: 🐛 type supports fields with previous text
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