Rename printNumber to printIndex and add comment

leancodepl · Nov 5, 2024 · f9734d9 · f9734d9
1 parent 33174dd
commit f9734d9
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/packages/patrol_log/lib/src/step_entry.dart b/packages/patrol_log/lib/src/step_entry.dart
@@ -39,10 +39,12 @@ class StepEntry extends Entry {
 
   @override
   String pretty({int? number}) {
-    return '$indentation${status.name} ${printNumber(number)} $action';
+    return '$indentation${status.name} ${printIndex(number)} $action';
   }
 
-  String printNumber(int? number) {
+  /// Returns the index of the step with the correct number of spaces,
+  /// to format the output.
+  String printIndex(int? number) {
     if (number != null) {
       if (number < 10) {
         return '  $number.';