Make a comment about the deepcopys in generate_config

ssciwr · Nov 20, 2023 · c791069 · c791069
1 parent 5ba26fb
commit c791069
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/precommit_recommendations/core.py b/precommit_recommendations/core.py
@@ -44,6 +44,9 @@ def generate_config(hooks):
         os.path.join(os.path.dirname(__file__), ".pre-commit-config.yaml"), "r"
     ) as f:
         data = strictyaml.load(f.read())
+
+    # NB: The deepcopy's here might seem unnecessary, but they are required
+    # because modification of strictyaml objects is a difficult process.
     output = copy.deepcopy(data)
 
     def _remove_hook(hook_id):