-
Notifications
You must be signed in to change notification settings - Fork 6.8k
test: add characterization tests for DocsMarkedRenderer #19413
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
Conversation
d6072a2
to
249ea4b
Compare
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.
Thanks for this!
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.
Looks great, thanks so much!
{ | ||
"example": "exampleName", | ||
"file": "example-html.html", | ||
"region": "some-region", |
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.
the final ,
messes up JSON.parse
(one of the few things that was wrong with the new API
for DocsMarkedRenderer#html)
I'll submit a patch to fix them
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'll wait for that fix before I submit this.
Edit: Actually, it might be good for this to go in first so you can update the test and verify your fix works.
These tests are meant to simply document and verify the existing behavior of the DocsMarkedRenderer. They aren't necessarily meant to be a good example of unit testing best-practices. A characterization test "is a means to describe (characterize) the actual behavior of an existing piece of software, and therefore protect existing behavior of legacy code against unintended changes via automated testing." https://en.wikipedia.org/wiki/Characterization_test
249ea4b
to
6aa8d6f
Compare
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.
Nice!
These tests are meant to simply document and verify the existing behavior of the DocsMarkedRenderer. They aren't necessarily meant to be a good example of unit testing best-practices. A characterization test "is a means to describe (characterize) the actual behavior of an existing piece of software, and therefore protect existing behavior of legacy code against unintended changes via automated testing." https://en.wikipedia.org/wiki/Characterization_test
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
These tests are meant to simply document and verify the existing
behavior of the DocsMarkedRenderer. They aren't necessarily meant to be
a good example of unit testing best-practices.
A characterization test "is a means to describe (characterize) the actual behavior of an existing piece of software, and therefore protect existing behavior of legacy code against unintended changes via automated testing."
https://en.wikipedia.org/wiki/Characterization_test