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(cli): use admonitions #12525

Merged
merged 3 commits into from
Mar 2, 2022
Merged

docs(cli): use admonitions #12525

merged 3 commits into from
Mar 2, 2022

Conversation

Biki-das
Copy link
Contributor

@Biki-das Biki-das commented Mar 1, 2022

in ref to comment #12498 (comment), I am starting to make seperate PR for each file. This one is the first one in order of document

cc @SimenB

@Biki-das
Copy link
Contributor Author

Biki-das commented Mar 1, 2022

@SimenB if there are files which had less changes at the last should i make them in 1 PR?

docs/CLI.md Outdated
@@ -298,7 +324,11 @@ Alias: `-i`. Run all tests serially in the current process, rather than creating

Run only the tests that were specified with their exact paths.

_Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
:::note
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@SimenB should this be a tip?

Copy link
Member

Choose a reason for hiding this comment

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

yes, I think so 👍

docs/CLI.md Outdated
@@ -337,7 +367,11 @@ Note that `column` is 0-indexed while `line` is not.

Alias: -t. Run only tests with a name that matches the regex. For example, suppose you want to run only tests related to authorization which will have names like "GET /api/posts with auth", then you can use jest -t=auth.

Note: The regex is matched against the full name, which is a combination of the test name and all its surrounding describe blocks.
:::note
Copy link
Member

Choose a reason for hiding this comment

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

here as well, tip I think

@Biki-das
Copy link
Contributor Author

Biki-das commented Mar 2, 2022

@SimenB done :-) with all the changes, this is good to go

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!

@SimenB SimenB changed the title feat :-(CLI)doc refactor with admonitions docs(cli): use admonitions Mar 2, 2022
@SimenB SimenB merged commit 3fbf2da into jestjs:main Mar 2, 2022
@github-actions
Copy link

github-actions bot commented Apr 2, 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 Apr 2, 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.

3 participants