feat: Added comments for better code readability!

TogetherCrew · Feb 19, 2024 · 9bd71eb · 9bd71eb
1 parent db8ca9b
commit 9bd71eb
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/utils/query_engine/level_based_platforms_util.py b/utils/query_engine/level_based_platforms_util.py
@@ -124,6 +124,8 @@ def prepare_context_str_based_on_summaries(
                                 "messages:\n"
                             )
                         elif level1_title == "None":
+                            # if it was None, then we would say it is the main level2_key
+                            # e.g.: for the thread in discord we would say the main channel
                             node_context: str = (
                                 f"{self.level1_key}: main {self.level2_key}\n"
                                 f"{self.level2_key}: {level2_title}\n"
@@ -132,6 +134,7 @@ def prepare_context_str_based_on_summaries(
                                 "messages:\n"
                             )
                         elif level2_title == "None":
+                            # if it was None, then we would say it is the main level1_key
                             node_context: str = (
                                 f"{self.level1_key}: {level1_title}\n"
                                 f"{self.level2_key}: main {self.level1_key}\n"