Ensure all the remarks make it into our documentation

elastic · Nov 26, 2020 · 7643c19 · 7643c19
1 parent 5e2c7f3
commit 7643c19
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/...ore/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md b/...ore/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md
@@ -29,7 +29,7 @@ incrementCounter(type: string, id: string, counterFieldNames: string[], options?
 
 ## Remarks
 
-When using incrementCounter for collecting usage data, you need to ensure that usage collection happens on a best-effort basis and doesn't negatively affect your plugin or users (see the example): - Swallow any exceptions thrown from the incrementCounter method and log a message in development. - Don't block your application on the incrementCounter method (e.g. don't use `await`<!-- -->)
+When supplying a field name like `stats.api.counter` the field name will be used as-is to create a document like: `{attributes: {'stats.api.counter': 1}}` It will not create a nested structure like: `{attributes: {stats: {api: {counter: 1}}}}`
 
 ## Example
 

diff --git a/src/core/server/saved_objects/service/lib/repository.ts b/src/core/server/saved_objects/service/lib/repository.ts
@@ -1526,7 +1526,7 @@ export class SavedObjectsRepository {
    *    a message in development.
    *  - Don't block your application on the incrementCounter method (e.g.
    *    don't use `await`)
-   *
+   * @remarks
    * When supplying a field name like `stats.api.counter` the field name will
    * be used as-is to create a document like:
    *   `{attributes: {'stats.api.counter': 1}}`