woops updated docs the wrong way!

WordPress · Apr 11, 2019 · 0bb2bf7 · 0bb2bf7 · aduth · Apr 11, 2019
1 parent 4574a38
commit 0bb2bf7
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/packages/data/README.md b/packages/data/README.md
@@ -332,7 +332,8 @@ _Returns_
 Given the name of a registered store, returns an object of the store's action creators.
 Calling an action creator will cause it to be dispatched, updating the state value accordingly.
 
-Note: This will return a promise.
+Note: Action creators returned by the dispatch will return a promise when
+they are called.
 
 _Usage_
 

diff --git a/packages/data/src/index.js b/packages/data/src/index.js
@@ -79,8 +79,8 @@ export const select = defaultRegistry.select;
  * Given the name of a registered store, returns an object of the store's action creators.
  * Calling an action creator will cause it to be dispatched, updating the state value accordingly.
  *
- * Note: If the action creator is a generator or returns a promise, a promise is
- * returned. Otherwise, the dispatch will return `undefined`.
+ * Note: Action creators returned by the dispatch will return a promise when
+ * they are called.
  *
  * @param {string} name Store name
  *