Clarify the default throwOnError behavior

WordPress · Mar 11, 2022 · 291d425 · 291d425
1 parent 7ae5525
commit 291d425
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/docs/reference-guides/data/data-core.md b/docs/reference-guides/data/data-core.md
@@ -536,7 +536,7 @@ _Parameters_
 -   _query_ `?Object`: Special query parameters for the DELETE API call.
 -   _options_ `[Object]`: Delete options.
 -   _options.\_\_unstableFetch_ `[Function]`: Internal use only. Function to call instead of `apiFetch()`. Must return a promise.
--   _options.throwOnError_ `[boolean]`: If false, this action suppresses all the exceptions.
+-   _options.throwOnError_ `[boolean]`: If false, this action suppresses all the exceptions. Defaults to false.
 
 ### editEntityRecord
 
@@ -704,7 +704,7 @@ _Parameters_
 -   _options_ `Object`: Saving options.
 -   _options.isAutosave_ `[boolean]`: Whether this is an autosave.
 -   _options.\_\_unstableFetch_ `[Function]`: Internal use only. Function to call instead of `apiFetch()`. Must return a promise.
--   _options.throwOnError_ `[boolean]`: If false, this action suppresses all the exceptions.
+-   _options.throwOnError_ `[boolean]`: If false, this action suppresses all the exceptions. Defaults to false.
 
 ### undo
 

diff --git a/packages/core-data/README.md b/packages/core-data/README.md
@@ -70,7 +70,7 @@ _Parameters_
 -   _query_ `?Object`: Special query parameters for the DELETE API call.
 -   _options_ `[Object]`: Delete options.
 -   _options.\_\_unstableFetch_ `[Function]`: Internal use only. Function to call instead of `apiFetch()`. Must return a promise.
--   _options.throwOnError_ `[boolean]`: If false, this action suppresses all the exceptions.
+-   _options.throwOnError_ `[boolean]`: If false, this action suppresses all the exceptions. Defaults to false.
 
 ### editEntityRecord
 
@@ -238,7 +238,7 @@ _Parameters_
 -   _options_ `Object`: Saving options.
 -   _options.isAutosave_ `[boolean]`: Whether this is an autosave.
 -   _options.\_\_unstableFetch_ `[Function]`: Internal use only. Function to call instead of `apiFetch()`. Must return a promise.
--   _options.throwOnError_ `[boolean]`: If false, this action suppresses all the exceptions.
+-   _options.throwOnError_ `[boolean]`: If false, this action suppresses all the exceptions. Defaults to false.
 
 ### undo
 

diff --git a/packages/core-data/src/actions.js b/packages/core-data/src/actions.js
@@ -219,7 +219,7 @@ export function receiveEmbedPreview( url, preview ) {
  *                                                call instead of `apiFetch()`.
  *                                                Must return a promise.
  * @param {boolean}  [options.throwOnError=false] If false, this action suppresses all
- *                                                the exceptions.
+ *                                                the exceptions. Defaults to false.
  */
 export const deleteEntityRecord = (
 	kind,
@@ -401,7 +401,7 @@ export function __unstableCreateUndoLevel() {
  *                                                call instead of `apiFetch()`.
  *                                                Must return a promise.
  * @param {boolean}  [options.throwOnError=false] If false, this action suppresses all
- *                                                the exceptions.
+ *                                                the exceptions. Defaults to false.
  */
 export const saveEntityRecord = (
 	kind,