Update docs

jestjs · Sep 25, 2023 · 042fddd · 042fddd
1 parent de9edca
commit 042fddd
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/CLI.md b/docs/CLI.md
@@ -481,11 +481,11 @@ The regex is matched against the full name, which is a combination of the test n
 
 ### `--testPathIgnorePatterns=<regex>|[array]`
 
-A single or array of regexp pattern strings that are tested against all tests paths before executing the test. Contrary to `--testPathPattern`, it will only run those tests with a path that does not match with the provided regexp expressions.
+A single or array of regexp pattern strings that are tested against all tests paths before executing the test. Contrary to `--testPathPatterns`, it will only run those tests with a path that does not match with the provided regexp expressions.
 
 To pass as an array use escaped parentheses and space delimited regexps such as `\(/node_modules/ /tests/e2e/\)`. Alternatively, you can omit parentheses by combining regexps into a single regexp like `/node_modules/|/tests/e2e/`. These two examples are equivalent.
 
-### `--testPathPattern=<regex>`
+### `--testPathPatterns=<regex>`
 
 A regexp pattern string that is matched against all tests paths before executing the test. On Windows, you will need to use `/` as a path separator or escape `\` as `\\`.
 

diff --git a/docs/WatchPlugins.md b/docs/WatchPlugins.md
@@ -172,7 +172,7 @@ For stability and safety reasons, only part of the global configuration keys can
 - [`onlyFailures`](configuration#onlyfailures-boolean)
 - [`reporters`](configuration#reporters-arraymodulename--modulename-options)
 - [`testNamePattern`](cli#--testnamepatternregex)
-- [`testPathPatterns`](cli#--testpathpatternregex)
+- [`testPathPatterns`](cli#--testpathpatternsregex)
 - [`updateSnapshot`](cli#--updatesnapshot)
 - [`verbose`](configuration#verbose-boolean)
 

diff --git a/packages/jest-util/Readme.md b/packages/jest-util/Readme.md
@@ -78,9 +78,9 @@ Used to set properties with specified values within a global object. It is desig
 
 It defines constants and conditional values for handling platform-specific behaviors in a terminal environment. It determines if the current platform is Windows ('win32') and sets up constants for various symbols and terminal screen clearing escape sequences accordingly, ensuring proper display and behavior on both Windows and non-Windows operating systems.
 
-## `testPathPatternToRegExp`
+## `TestPathPatterns`
 
-This function is used for consistency when serializing/deserializing global configurations and ensures that consistent regular expressions are produced for matching test paths.
+This class takes test patterns and provides the API for deciding if a test matches any of the patterns.
 
 ## `tryRealpath`