annotating issues

splunk · Dec 10, 2024 · 8362af7 · 8362af7
1 parent 390c372
commit 8362af7
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/contentctl/actions/detection_testing/DetectionTestingManager.py b/contentctl/actions/detection_testing/DetectionTestingManager.py
@@ -67,6 +67,7 @@ def sigint_handler(signum, frame):
 
         signal.signal(signal.SIGINT, sigint_handler)
 
+        # TODO (#337): futures can be hard to maintain/debug; let's consider alternatives
         with concurrent.futures.ThreadPoolExecutor(
             max_workers=len(self.input_dto.config.test_instances),
         ) as instance_pool, concurrent.futures.ThreadPoolExecutor(

diff --git a/contentctl/actions/detection_testing/views/DetectionTestingViewCLI.py b/contentctl/actions/detection_testing/views/DetectionTestingViewCLI.py
@@ -51,7 +51,7 @@ def showStatus(self, interval: int = 1):
         while True:
             summary = self.getSummaryObject()
 
-            # TODO (cmcginley): there's a 1-off error here I think (we show one more than we
+            # TODO (#338): there's a 1-off error here I think (we show one more than we
             #   actually have during testing)
             total = len(
                 summary.get("tested_detections", [])

diff --git a/contentctl/output/conf_output.py b/contentctl/output/conf_output.py
@@ -79,7 +79,7 @@ def writeMiscellaneousAppFiles(self)->set[pathlib.Path]:
 
         return written_files
 
-    # TODO (cmcginley): we could have a discrepancy between detections tested and those delivered
+    # TODO (#339): we could have a discrepancy between detections tested and those delivered
     #   based on the jinja2 template
     #   {% if (detection.type == 'TTP' or detection.type == 'Anomaly' or detection.type == 'Hunting' or detection.type == 'Correlation') %}
     def writeObjects(self, objects: list, type: SecurityContentType = None) -> set[pathlib.Path]: