add important clarification doc removed in #15896 (#15987)

WordPress · Jun 5, 2019 · 705497b · 705497b
1 parent 3c0b12b
commit 705497b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/packages/data/README.md b/packages/data/README.md
@@ -684,6 +684,10 @@ const SaleButton = withDispatch( ( dispatch, ownProps, { select } ) => {
 //  <SaleButton>Start Sale!</SaleButton>
 ```
 
+_Note:_ It is important that the `mapDispatchToProps` function always
+returns an object with the same keys. For example, it should not contain
+conditions under which a different value would be returned.
+
 _Parameters_
 
 -   _mapDispatchToProps_ `Function`: A function of returning an object of prop names where value is a dispatch-bound action creator, or a function to be called with the component's props and returning an action creator.

diff --git a/packages/data/src/components/with-dispatch/index.js b/packages/data/src/components/with-dispatch/index.js
@@ -81,6 +81,10 @@ import { useDispatchWithMap } from '../use-dispatch';
  * //  <SaleButton>Start Sale!</SaleButton>
  * ```
  *
+ * _Note:_ It is important that the `mapDispatchToProps` function always
+ * returns an object with the same keys. For example, it should not contain
+ * conditions under which a different value would be returned.
+ *
  * @return {Component} Enhanced component with merged dispatcher props.
  */
 const withDispatch = ( mapDispatchToProps ) => createHigherOrderComponent(