Automatically comment parameters that are Undefined to keep them docu…

…mented but not crashing everything in case they're optional.
cta-observatory · Jul 6, 2023 · 5af793d · 5af793d
1 parent 83ab9b2
commit 5af793d
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/ctapipe/core/config_writer.py b/ctapipe/core/config_writer.py
@@ -65,6 +65,11 @@ def commented(text, indent_level=indent_level, width=144):
     if isinstance(trait, traitlets.Unicode):
         trait_value = f"'{trait_value}'"
 
-    trait_repr += f"{indent_str*indent_level}{trait.name}: {trait_value}\n"
+    # Automatically comment all parameters that are unvalid
+    commented = ""
+    if trait_value == traitlets.Undefined:
+        commented = "#"
+
+    trait_repr += f"{indent_str*indent_level}{commented}{trait.name}: {trait_value}\n"
 
     return trait_repr