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

docs(svelte-testing-library): update API docs for v5 release #1369

Merged
merged 5 commits into from
Apr 29, 2024

Conversation

mcous
Copy link
Contributor

@mcous mcous commented Feb 17, 2024

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 the svelte-testing-library docs accordingly, with callouts for users of the current v4.

CC @yanick

Copy link

netlify bot commented Feb 17, 2024

Deploy Preview for testing-library ready!

Name Link
🔨 Latest commit 02fc308
🔍 Latest deploy log https://app.netlify.com/sites/testing-library/deploys/662423399a01d60008920c86
😎 Deploy Preview https://deploy-preview-1369--testing-library.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@yanick yanick left a 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!

Copy link
Contributor Author

@mcous mcous left a comment

Choose a reason for hiding this comment

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

A few typos

docs/svelte-testing-library/api.mdx Outdated Show resolved Hide resolved
docs/svelte-testing-library/api.mdx Outdated Show resolved Hide resolved
docs/svelte-testing-library/api.mdx Outdated Show resolved Hide resolved
@mcous mcous marked this pull request as ready for review April 20, 2024 15:07
@mcous
Copy link
Contributor Author

mcous commented Apr 20, 2024

@timdeschryver (pinging you because you’ve reviewed my previous STL docs PRs) we just released v5 to our latest tag, so these docs are ready to go. I’ve synced up and undrafted the PR accordingly

CC @yanick

Copy link
Member

@timdeschryver timdeschryver left a 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.

docs/svelte-testing-library/api.mdx Outdated Show resolved Hide resolved
docs/svelte-testing-library/api.mdx Outdated Show resolved Hide resolved
docs/svelte-testing-library/api.mdx Outdated Show resolved Hide resolved
Co-authored-by: Tim Deschryver <28659384+timdeschryver@users.noreply.github.com>
@mcous
Copy link
Contributor Author

mcous commented Apr 20, 2024

Thanks for the careful review!

@mcous
Copy link
Contributor Author

mcous commented Apr 29, 2024

@timdeschryver Is there anything blocking merge here? We just got an inbound issue due to improper API usage that this doc update details

@timdeschryver timdeschryver merged commit 288b86f into testing-library:main Apr 29, 2024
4 checks passed
@timdeschryver
Copy link
Member

@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!

@mcous mcous deleted the update-svelte-api branch April 29, 2024 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants