Fix comments

Signed-off-by: Kaituo Li <[email protected]>
kaituo · Jul 11, 2023 · b3e0e03 · b3e0e03
1 parent ff7bb29
commit b3e0e03
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/src/main/java/org/opensearch/forecast/indices/ForecastIndexManagement.java b/src/main/java/org/opensearch/forecast/indices/ForecastIndexManagement.java
@@ -204,8 +204,8 @@ public void initCheckpointIndex(ActionListener<CreateIndexResponse> actionListen
         } catch (IOException e) {
             throw new EndRunException("", "Cannot find checkpoint mapping file", true);
         }
-        // AD indices need RAW (e.g., we want users to be able to consume AD results as soon as possible and send out an alert if anomalies
-        // found).
+        // forecast indices need RAW (e.g., we want users to be able to consume forecast results as soon as
+        // possible and send out an alert if a threshold is breached).
         Settings replicationSettings = Settings.builder().put(SETTING_REPLICATION_TYPE, DOCUMENT.name()).build();
         CreateIndexRequest request = new CreateIndexRequest(ForecastCommonName.FORECAST_CHECKPOINT_INDEX_NAME, replicationSettings)
             .mapping(mapping, XContentType.JSON);

diff --git a/src/main/java/org/opensearch/timeseries/indices/IndexManagement.java b/src/main/java/org/opensearch/timeseries/indices/IndexManagement.java
@@ -428,8 +428,8 @@ public void initConfigIndexIfAbsent(ActionListener<CreateIndexResponse> actionLi
      * @throws IOException IOException from {@link IndexManagement#getConfigMappings}
      */
     public void initConfigIndex(ActionListener<CreateIndexResponse> actionListener) throws IOException {
-        // AD indices need RAW (e.g., we want users to be able to consume AD results as soon as possible and send out an alert if anomalies
-        // found).
+        // time series indices need RAW (e.g., we want users to be able to consume AD results as soon as possible
+        // and send out an alert if anomalies found).
         Settings replicationSettings = Settings.builder().put(SETTING_REPLICATION_TYPE, DOCUMENT.name()).build();
         CreateIndexRequest request = new CreateIndexRequest(CommonName.CONFIG_INDEX, replicationSettings)
             .mapping(getConfigMappings(), XContentType.JSON)
@@ -482,8 +482,8 @@ public static String getJobMappings() throws IOException {
      */
     public void initJobIndex(ActionListener<CreateIndexResponse> actionListener) {
         try {
-            // AD indices need RAW (e.g., we want users to be able to consume AD results as soon as possible and send out an alert if
-            // anomalies found).
+            // time series indices need RAW (e.g., we want users to be able to consume AD results as soon as
+            // possible and send out an alert if anomalies found).
             Settings replicationSettings = Settings.builder().put(SETTING_REPLICATION_TYPE, DOCUMENT.name()).build();
             CreateIndexRequest request = new CreateIndexRequest(CommonName.JOB_INDEX, replicationSettings)
                 .mapping(getJobMappings(), XContentType.JSON);
@@ -937,8 +937,8 @@ protected void rolloverAndDeleteHistoryIndex(
 
         CreateIndexRequest createRequest = rollOverRequest.getCreateIndexRequest();
 
-        // AD indices need RAW (e.g., we want users to be able to consume AD results as soon as possible and send out an alert if anomalies
-        // found).
+        // time series indices need RAW (e.g., we want users to be able to consume AD results as soon as possible
+        // and send out an alert if anomalies found).
         Settings replicationSettings = Settings.builder().put(SETTING_REPLICATION_TYPE, DOCUMENT.name()).build();
         createRequest.index(rolloverIndexPattern).settings(replicationSettings).mapping(resultMapping, XContentType.JSON);
 
@@ -965,8 +965,8 @@ protected void initResultIndexDirectly(
         IndexType resultIndex,
         ActionListener<CreateIndexResponse> actionListener
     ) {
-        // AD indices need RAW (e.g., we want users to be able to consume AD results as soon as possible and send out an alert if anomalies
-        // found).
+        // time series indices need RAW (e.g., we want users to be able to consume AD results as soon as possible
+        // and send out an alert if anomalies found).
         Settings replicationSettings = Settings.builder().put(SETTING_REPLICATION_TYPE, DOCUMENT.name()).build();
         CreateIndexRequest request = new CreateIndexRequest(resultIndexName, replicationSettings).mapping(resultMapping, XContentType.JSON);
         if (alias != null) {