Update JSdocs

There was a typo, and I took the opportunity to reword it a bit too
elastic · Sep 10, 2020 · f345891 · f345891
1 parent 70793b0
commit f345891
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/...velopment/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.md b/...velopment/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.md
@@ -17,6 +17,6 @@ export interface SavedObjectsBulkUpdateObject<T = unknown> extends Pick<SavedObj
 |  --- | --- | --- |
 |  [attributes](./kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md) | <code>Partial&lt;T&gt;</code> | The data for a Saved Object is stored as an object in the <code>attributes</code> property. |
 |  [id](./kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md) | <code>string</code> | The ID of this Saved Object, guaranteed to be unique for all objects of the same <code>type</code> |
-|  [namespace](./kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md) | <code>string</code> | Optional namespace string to use for this document. If this is defined, it will supersede the namespace ID that is in [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md)<!-- -->.<!-- -->Note: the default namespace's string representation is <code>'default'</code>, and its ID representation is <code>undefined</code>. |
+|  [namespace](./kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md) | <code>string</code> | Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md)<!-- -->.<!-- -->Note: the default namespace's string representation is <code>'default'</code>, and its ID representation is <code>undefined</code>. |
 |  [type](./kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md) | <code>string</code> | The type of this Saved Object. Each plugin can define it's own custom Saved Object types. |
 
diff --git a/...core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md b/...core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md
@@ -4,7 +4,7 @@
 
 ## SavedObjectsBulkUpdateObject.namespace property
 
-Optional namespace string to use for this document. If this is defined, it will supersede the namespace ID that is in [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md)<!-- -->.
+Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md)<!-- -->.
 
 Note: the default namespace's string representation is `'default'`<!-- -->, and its ID representation is `undefined`<!-- -->.
 

diff --git a/src/core/server/saved_objects/service/saved_objects_client.ts b/src/core/server/saved_objects/service/saved_objects_client.ts
@@ -81,8 +81,8 @@ export interface SavedObjectsBulkUpdateObject<T = unknown>
   /** {@inheritdoc SavedObjectAttributes} */
   attributes: Partial<T>;
   /**
-   * Optional namespace string to use for this document. If this is defined, it will supersede the namespace ID that is in
-   * {@link SavedObjectsUpdateOptions}.
+   * Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in
+   * {@link SavedObjectsBulkUpdateOptions}.
    *
    * Note: the default namespace's string representation is `'default'`, and its ID representation is `undefined`.
    **/