Add comment for rationale of heurisitic constraint

Yelp · Feb 7, 2022 · 860da07 · 860da07
1 parent 2f4f956
commit 860da07
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/detect_secrets/filters/heuristic.py b/detect_secrets/filters/heuristic.py
@@ -165,6 +165,8 @@ def is_indirect_reference(line: str) -> bool:
 
         secret = request.headers['apikey']
     """
+    # Constain lines as the heuristics intention is to target relatively short function like strings
+    # This constraint also avoids catastrophic backtracking failures of the regex.
     if len(line) > 1000:
         return False
     return bool(_get_indirect_reference_regex().search(line))