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

Update documentation for --filter CLI option (see #12260) #12799

Merged
merged 4 commits into from
May 5, 2022

Conversation

gramsco
Copy link
Contributor

@gramsco gramsco commented May 3, 2022

Summary

This PR specifies how to use the filtering function CLI option. Previous documentation was slightly ambiguous as pointed out in the comments of #12260.

This PR specifies how to use the filtering function CLI option.
@facebook-github-bot
Copy link
Contributor

Hi @gramsco!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign 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 to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@gramsco gramsco changed the title Update documentation (see #12260) Update documentation for --filter CLI option (see #12260) May 3, 2022
@mrazauskas
Copy link
Contributor

Good move. I think it would be useful to mention setup() hook as well. It was added in #8142. Can be done later as well.

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

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

thanks!

can you update all versions of the docs as well?

image

Also, run prettier over the file

ran prettier
Copy link
Contributor Author

@gramsco gramsco left a comment

Choose a reason for hiding this comment

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

CLI.md * 😄

@SimenB SimenB merged commit 3390ec4 into jestjs:main May 5, 2022
@github-actions
Copy link

github-actions bot commented Jun 5, 2022

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 Jun 5, 2022
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