-
Notifications
You must be signed in to change notification settings - Fork 404
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
doc: Better documentation for toContaintHTML #363
Conversation
Codecov Report
@@ Coverage Diff @@
## main #363 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 23 23
Lines 554 554
Branches 199 199
=========================================
Hits 554 554 Continue to review full report at Codecov.
|
I tagged some folks here to get an approving review and a second pair of eyes and your opinion. Thanks! |
README.md
Outdated
@@ -491,7 +491,7 @@ toContainHTML(htmlText: string) | |||
``` | |||
|
|||
Assert whether a string representing a HTML element is contained in another | |||
element: | |||
element. The string should contain valid html, and not any substrings of html. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"substrings of html" is a bit unclear to me. It sounds like <p></p>
would be considered a "substring" but that's valid HTML. An example would help here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree this is probably not the clearest terms. But the examples are below. Do you think we need examples of what won't work? Like for instance, this:
// These won't work
render(<div class="test">text</div>)
expect(element).toContainHTML('</div>')
expect(element).toContainHTML('class="test"')
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think "partial HTML" or "incomplete HTML" is more fitting here.
Oh and move the comment since the render does work.
-// These won't work
render(<div class="test">text</div>)
+// These won't work
expect(element).toContainHTML('</div>')
expect(element).toContainHTML('class="test"')
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool. Thanks for your advice. I'll do that.
🎉 This PR is included in version 5.13.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
What:
More explicit requirements in the documentation of
toContainHTML
.Why:
#362 (comment)
How:
Checklist:
Fixes #362.