diff --git a/CHANGELOG.md b/CHANGELOG.md index 711923323d7d..a761caa7db16 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,8 @@ from source. ([#5177](https://github.com/facebook/jest/pull/5177)) * `[jest-validate]` Add ability to log deprecation warnings for CLI flags. ([#5536](https://github.com/facebook/jest/pull/5536)) +* `[docs]` Add a documentation note for project `displayName` configuration + ([#5600](https://github.com/facebook/jest/pull/5600)) ## jest 22.3.0 diff --git a/docs/Configuration.md b/docs/Configuration.md index 4f27f9cc0bb1..32a7746929a4 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -460,6 +460,10 @@ the same invocation of Jest: } ``` +_Note: When using multi project runner, it's recommended to add a `displayName` +for each project. This will show the `displayName` of a project next to its +tests._ + ### `clearMocks` [boolean] Default: `false`