Core Data: Add missing param doc for saveEntityRecord() (#22966)

WordPress · Jun 6, 2020 · 37c0a41 · 37c0a41
1 parent cce4eb9
commit 37c0a41
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/docs/designers-developers/developers/data/data-core.md b/docs/designers-developers/developers/data/data-core.md
@@ -634,6 +634,7 @@ _Parameters_
 -   _name_ `string`: Name of the received entity.
 -   _record_ `Object`: Record to be saved.
 -   _options_ `Object`: Saving options.
+-   _options.isAutosave_ `[boolean]`: Whether this is an autosave.
 
 <a name="undo" href="#undo">#</a> **undo**
 

diff --git a/packages/core-data/README.md b/packages/core-data/README.md
@@ -217,6 +217,7 @@ _Parameters_
 -   _name_ `string`: Name of the received entity.
 -   _record_ `Object`: Record to be saved.
 -   _options_ `Object`: Saving options.
+-   _options.isAutosave_ `[boolean]`: Whether this is an autosave.
 
 <a name="undo" href="#undo">#</a> **undo**
 

diff --git a/packages/core-data/src/actions.js b/packages/core-data/src/actions.js
@@ -249,10 +249,11 @@ export function __unstableCreateUndoLevel() {
 /**
  * Action triggered to save an entity record.
  *
- * @param {string} kind    Kind of the received entity.
- * @param {string} name    Name of the received entity.
- * @param {Object} record  Record to be saved.
- * @param {Object} options Saving options.
+ * @param {string}  kind                       Kind of the received entity.
+ * @param {string}  name                       Name of the received entity.
+ * @param {Object}  record                     Record to be saved.
+ * @param {Object}  options                    Saving options.
+ * @param {boolean} [options.isAutosave=false] Whether this is an autosave.
  */
 export function* saveEntityRecord(
 	kind,