From 093040f8171eab364a5cb190f77f96e16471f846 Mon Sep 17 00:00:00 2001
From: dmotte <37443982+dmotte@users.noreply.github.com>
Date: Sun, 29 Dec 2024 04:16:21 +0100
Subject: [PATCH] Improved comment about similarity

---
 smartchg/cli.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/smartchg/cli.py b/smartchg/cli.py
index cea2980..5eb025a 100644
--- a/smartchg/cli.py
+++ b/smartchg/cli.py
@@ -132,8 +132,8 @@ def compute_stuff(data: list[dict], today: date, lookbehind: int,
         # - entry['upper']: upper "pseudo-bollinger" for the rate value
         # - entry['lower']: lower "pseudo-bollinger" for the rate value
         # - entry['center']: center between the two "pseudo-bollinger" values
-        # - entry['simil']: how much entry['offset'] and offset_mean are
-        #   similar. For example:
+        # - entry['simil']: similarity between entry['offset'] and offset_mean.
+        #   For example:
         #   - if entry['offset'] == offset_mean then --> simil = 0
         #   - if entry['offset'] == offset_upper then --> simil = 1
         #   - if entry['offset'] == offset_lower then --> simil = -1