Update 'getOrLoadEntitiesConfig' doc-block

WordPress · Mar 20, 2024 · fb77e6b · fb77e6b
1 parent f95e7af
commit fb77e6b
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/packages/core-data/src/entities.js b/packages/core-data/src/entities.js
@@ -469,10 +469,12 @@ function registerSyncConfigs( configs ) {
 }
 
 /**
- * Loads the kind entities into the store.
+ * Loads the entities into the store.
  *
- * @param {string}  kind Kind
- * @param {?string} name Name
+ * Note: The `name` argument is used for `root` entities requiring additional server data.
+ *
+ * @param {string} kind Kind
+ * @param {string} name Name
  * @return {(thunkArgs: object) => Promise<Array>} Entities
  */
 export const getOrLoadEntitiesConfig =