lint

packages/core-data/src/locks/actions.js

@@ -1,15 +1,15 @@
 /**
  * WordPress dependencies
  */
-import { awaitPromise } from '@wordpress/data-controls';
+import { __unstableAwaitPromise } from '@wordpress/data-controls';
 import { controls } from '@wordpress/data';
 
 export function* __unstableAcquireStoreLock( store, path, { exclusive } ) {
 	const promise = yield* __unstableEnqueueLockRequest( store, path, {
 		exclusive,
 	} );
 	yield* __unstableProcessPendingLockRequests();
-	return yield awaitPromise( promise );
+	return yield __unstableAwaitPromise( promise );
 }
 
 export function* __unstableEnqueueLockRequest( store, path, { exclusive } ) {

packages/data-controls/README.md

@@ -45,10 +45,6 @@ _Returns_
 
 -   `Object`: The control descriptor.
 
-<a name="awaitPromise" href="#awaitPromise">#</a> **awaitPromise**
-
-Undocumented declaration.
-
 <a name="controls" href="#controls">#</a> **controls**
 
 The default export is what you use to register the controls with your custom

packages/data-controls/src/index.js

@@ -73,7 +73,26 @@ export function dispatch( ...args ) {
 	return dataControls.dispatch( ...args );
 }
 
-export const awaitPromise = function ( promise ) {
+/**
+ * Dispatches a control action for awaiting on a promise to be resolved.
+ *
+ * @param {Object} promise Promise to wait for.
+ *
+ * @example
+ * ```js
+ * import { __unstableAwaitPromise } from '@wordpress/data-controls';
+ *
+ * // Action generator using apiFetch
+ * export function* myAction() {
+ * 	const promise = getItemsAsync();
+ * 	const items = yield __unstableAwaitPromise( promise );
+ * 	// do something with the items.
+ * }
+ * ```
+ *
+ * @return {Object} The control descriptor.
+ */
+export const __unstableAwaitPromise = function ( promise ) {
 	return {
 		type: 'AWAIT_PROMISE',
 		promise,