Browse Source

[DOCS] Clarify results_index_name description (#35463)

Lisa Cawley 7 years ago
parent
commit
9aeaceac4b
1 changed files with 2 additions and 2 deletions
  1. 2 2
      docs/reference/ml/apis/put-job.asciidoc

+ 2 - 2
docs/reference/ml/apis/put-job.asciidoc

@@ -65,8 +65,8 @@ Instantiates a job.
   score are applied, as new data is seen. See <<ml-job-resource>>.
 
 `results_index_name`::
-  (string) The name of the index in which to store the {ml} results. The default
-  value is `shared`, which corresponds to the index name `.ml-anomalies-shared`.
+  (string) A text string that affects the name of the {ml} results index. The 
+  default value is `shared`, which generates an index named `.ml-anomalies-shared`. 
 
 `results_retention_days`::
   (long) Advanced configuration option. The number of days for which job results