fixed comments

Ericsson · Oct 25, 2023 · ff3a557 · ff3a557
1 parent 1a9dcd4
commit ff3a557
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 11 deletions.
diff --git a/application/src/main/resources/ecc.yml b/application/src/main/resources/ecc.yml
@@ -86,11 +86,13 @@ repair:
     time: 7
     unit: days
   ##
-  ##  The unit of time granularity for priority calculation, can be HOURS, MINUTES, or SECONDS.
-  ##  This unit is used in the calculation of priority.
-  ##  Default is HOURS for backward compatibility.
-  ##  Ensure to pause repair operations when changing the granularity to maintain consistency.
-  ##  HOURS  # or MINUTES, SECONDS
+  ## The unit of time granularity for priority calculation, can be HOURS, MINUTES, or SECONDS.
+  ## This unit is used in the calculation of priority.
+  ## Default is HOURS for backward compatibility.
+  ## Ensure to pause repair operations prior to changing the granularity.
+  ## Not doing so may lead to inconsistencies as some ecchronos instances
+  ## could have different priorities compared to others for the same repair.
+  ## Possible values are HOURS, MINUTES, or SECONDS.
   ##
   priority:
     granularity_unit: HOURS

diff --git a/core/src/main/java/com/ericsson/bss/cassandra/ecchronos/core/repair/RepairConfiguration.java b/core/src/main/java/com/ericsson/bss/cassandra/ecchronos/core/repair/RepairConfiguration.java
@@ -22,7 +22,7 @@
 /**
  * Configuration options for table repairs.
  */
-@SuppressWarnings ("FinalClass")
+@SuppressWarnings("FinalClass")
 public class RepairConfiguration
 {
     public static final double NO_UNWIND = 0.0d;

diff --git a/docs/UPGRADE.md b/docs/UPGRADE.md
@@ -35,11 +35,13 @@ It’s important to note that while making these changes, the default behavior r
 
 ## Priority Calculation
 
-The unit of time granularity for priority calculation, can be HOURS, MINUTES, or SECONDS.
-This unit is used in the calculation of priority. Default is HOURS for backward compatibility.
-Ensure to pause repair operations when changing the granularity to maintain consistency. 
-HOURS  # or MINUTES, SECONDS. It’s important to note that while making these changes, 
-the default behavior remains unchanged.
+The unit of time granularity used for priority calculation.
+Possible values are HOURS, MINUTES, or SECONDS.
+This unit influences how quickly the priority of a job increases.
+Default is set to HOURS for backward compatibility.
+IMPORTANT: Ensure to pause repair operations prior to changing the granularity. 
+Not doing so may lead to inconsistencies as some ecchronos instances could have 
+different priorities compared to others for the same repair.
 
 # Upgrade to 4.x