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

Removed misleading text about describe() grouping tests into a test suite #7452

Merged
merged 5 commits into from
Dec 25, 2018
Merged

Removed misleading text about describe() grouping tests into a test suite #7452

merged 5 commits into from
Dec 25, 2018

Conversation

urig
Copy link
Contributor

@urig urig commented Dec 3, 2018

Summary

As reported and confirmed in #7412, describe() does not:

groups together several related tests in one "test suite".

Rather, every test file is considered a single "test suite" regardless of how many top-level calls to `describe() it contains.

This bit of documentation is misleading to some users (ex: StackOverflow question).

This PR makes the documentation more accurate, reducing user confusion.

Test plan

Preview the change in GitHub, demonstrating contents and markdown are correct.

@facebook-github-bot
Copy link
Contributor

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@SimenB
Copy link
Member

SimenB commented Dec 3, 2018

@urig mind updating the versioned docs as well?

image

@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@urig
Copy link
Contributor Author

urig commented Dec 3, 2018

@urig mind updating the versioned docs as well?

Will do. 👍

@urig
Copy link
Contributor Author

urig commented Dec 4, 2018

@SimenB Done. Please note that I've also updated the comment for describe() in flow-typed/npm/jest_v23.x.x.js.

@SimenB SimenB merged commit 7f19e6e into jestjs:master Dec 25, 2018
captain-yossarian pushed a commit to captain-yossarian/jest that referenced this pull request Jul 18, 2019
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants