Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Remove contradiction from documentation #1430

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

Open
skonky wants to merge 1 commit into testing-library:main
base: main
Choose a base branch
Loading
from skonky:patch-1

Conversation

Copy link

@skonky skonky commented Sep 24, 2024
edited
Loading

I found something confusing in the documentation regarding testing-library-dom

Here you say that testing-library-dom should be resolved via the framework wrapper

And when you then go to the actual framework wrapper (in my case react) it states the following:

To get started with React Testing Library, you'll need to install it together with its peerDependency @testing-library/dom:
npm install --save-dev @testing-library/react @testing-library/dom

but this contradicts what is said earlier right?

remove the part that tells you to install @testing-library/dom because it is already included when using a framework wrapper
Copy link

netlify bot commented Sep 24, 2024
edited
Loading

Deploy Preview for testing-library ready!

Name Link
🔨 Latest commit fc3a68b
🔍 Latest deploy log https://app.netlify.com/sites/testing-library/deploys/66f2cfb35a118c0008bd83be
😎 Deploy Preview https://deploy-preview-1430--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.

@@ -9,11 +9,10 @@ APIs for working with React components.

## Installation

To get started with `React Testing Library`, you'll need to install it together
with its peerDependency `@testing-library/dom`:
To get started with `React Testing Library`, you'll need to install it.
Copy link
Author

Choose a reason for hiding this comment

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

maybe this text can even be removed as it's kind of stating the obvious

Copy link
Member

Hi @skonky, thanks for this.
This is not true anymore for all of our framework wrappers. RTL for examples does not include DTL anymore.
I believe that this should be fixed in user-event.

eps1lon and timdeschryver reacted with thumbs up emoji

Copy link
Author

skonky commented Sep 25, 2024

@MatanBobi Cool, I will update the docs to say the opposite of what I did in the current commit :)

MatanBobi reacted with thumbs up emoji

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants

AltStyle によって変換されたページ (->オリジナル) /