Update changelog and add more doc comments

WordPress · Apr 7, 2023 · af509a6 · af509a6
1 parent e7a481d
commit af509a6
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 12 deletions.
diff --git a/packages/data-controls/CHANGELOG.md b/packages/data-controls/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Breaking Changes
+
+-   Publish Typescript build types to npm. ([#49647](https://github.com/WordPress/gutenberg/pull/49647))
+
 ## 2.30.0 (2023-03-29)
 
 ## 2.29.0 (2023-03-15)

diff --git a/packages/data-controls/README.md b/packages/data-controls/README.md
@@ -83,8 +83,8 @@ Alias for the `dispatch` control in the `@wordpress/data` package.
 
 _Parameters_
 
--   _storeNameOrDescriptor_ `string | StoreDescriptor`:
--   _actionName_ `string`:
+-   _storeNameOrDescriptor_ `string | StoreDescriptor`: The store object or identifier.
+-   _actionName_ `string`: The action name.
 -   _args_ `any[]`: Arguments passed without change to the `@wordpress/data` control.
 
 ### select
@@ -94,8 +94,8 @@ Alias for the `resolveSelect` built-in control in the `@wordpress/data` package.
 
 _Parameters_
 
--   _storeNameOrDescriptor_ `string | StoreDescriptor`:
--   _selectorName_ `string`:
+-   _storeNameOrDescriptor_ `string | StoreDescriptor`: The store object or identifier.
+-   _selectorName_ `string`: The selector name.
 -   _args_ `any[]`: Arguments passed without change to the `@wordpress/data` control.
 
 ### syncSelect
@@ -105,8 +105,8 @@ Alias for the `select` built-in control in the `@wordpress/data` package.
 
 _Parameters_
 
--   _storeNameOrDescriptor_ `string | StoreDescriptor`:
--   _selectorName_ `string`:
+-   _storeNameOrDescriptor_ `string | StoreDescriptor`: The store object or identifier.
+-   _selectorName_ `string`: The selector name.
 -   _args_ `any[]`: Arguments passed without change to the `@wordpress/data` control.
 
 <!-- END TOKEN(Autogenerated API docs) -->

diff --git a/packages/data-controls/src/index.ts b/packages/data-controls/src/index.ts
@@ -37,8 +37,8 @@ export function apiFetch( request: APIFetchOptions ) {
  * Control for resolving a selector in a registered data store.
  * Alias for the `resolveSelect` built-in control in the `@wordpress/data` package.
  *
- * @param storeNameOrDescriptor
- * @param selectorName
+ * @param storeNameOrDescriptor The store object or identifier.
+ * @param selectorName          The selector name.
  * @param args                  Arguments passed without change to the `@wordpress/data` control.
  */
 export function select(
@@ -62,8 +62,8 @@ export function select(
  * Control for calling a selector in a registered data store.
  * Alias for the `select` built-in control in the `@wordpress/data` package.
  *
- * @param storeNameOrDescriptor
- * @param selectorName
+ * @param storeNameOrDescriptor The store object or identifier.
+ * @param selectorName          The selector name.
  * @param args                  Arguments passed without change to the `@wordpress/data` control.
  */
 export function syncSelect(
@@ -83,8 +83,8 @@ export function syncSelect(
  * Control for dispatching an action in a registered data store.
  * Alias for the `dispatch` control in the `@wordpress/data` package.
  *
- * @param storeNameOrDescriptor
- * @param actionName
+ * @param storeNameOrDescriptor The store object or identifier.
+ * @param actionName            The action name.
  * @param args                  Arguments passed without change to the `@wordpress/data` control.
  */
 export function dispatch(