add a documentation note for project displayName configuration (#5600)

* add a documentation note for project displayName configuration * add changelog
jestjs · Feb 17, 2018 · 4e4a9e0 · 4e4a9e0
1 parent e89de4e
commit 4e4a9e0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git 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
@@ -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`