-
Notifications
You must be signed in to change notification settings - Fork 720
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(svelte-testing-library): update API docs for v5 release #1369
Conversation
✅ Deploy Preview for testing-library ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
👍 Awesome. Let's flip the draft
status once v5 hits the shelves!
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.
A few typos
@timdeschryver (pinging you because you’ve reviewed my previous STL docs PRs) we just released v5 to our CC @yanick |
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 like the admonitions! 🤩
I left a few nits.
Co-authored-by: Tim Deschryver <28659384+timdeschryver@users.noreply.github.com>
Thanks for the careful review! |
@timdeschryver Is there anything blocking merge here? We just got an inbound issue due to improper API usage that this doc update details |
Oops 😅 it got off my radar. Thanks for the ping! |
This is a documentation companion to testing-library/svelte-testing-library#325. We're introducing a few minor, though technically breaking, changes to the API in the upcoming
v5
release (which should be triggered upon merge of the PR above).This PR updates the
API
section of thesvelte-testing-library
docs accordingly, with callouts for users of the currentv4
.CC @yanick