minor: set sort_keys to false when output to yaml file to make it mor…

…e readable; also added some comments

WIP

fixes: PolicyEngine#274

policyengine_core/parameters/parameter.py

@@ -47,6 +47,7 @@ class Parameter(AtInstantLike):
     """
 
     _exclusion_list = ["parent", "_at_instant_cache"]
+    """The keys to be excluded from the node when output to a yaml file."""
 
     def __init__(
         self, name: str, data: dict, file_path: Optional[str] = None

policyengine_core/parameters/parameter_node.py

@@ -34,6 +34,7 @@ class ParameterNode(AtInstantLike):
     )
 
     _exclusion_list = ["parent", "_at_instant_cache"]
+    """The keys to be excluded from the node when output to a yaml file."""
 
     parent: "ParameterNode" = None
     """The parent of the node, or None if the node is the root of the tree."""
@@ -298,6 +299,6 @@ def write_yaml(self, file_path: Path) -> yaml:
         data = self.get_attr_dict()
         try:
             with open(file_path, "w") as f:
-                yaml.dump(data, f, sort_keys=True, Dumper=self.NoAliasDumper)
+                yaml.dump(data, f, sort_keys=False, Dumper=self.NoAliasDumper)
         except Exception as e:
             print(f"Error when writing YAML file: {e}")

policyengine_core/parameters/parameter_scale.py

@@ -25,6 +25,7 @@ class ParameterScale(AtInstantLike):
     _allowed_keys = config.COMMON_KEYS.union({"brackets"})
 
     _exclusion_list = ["parent", "_at_instant_cache"]
+    """The keys to be excluded from the node when output to a yaml file."""
 
     def __init__(self, name: str, data: dict, file_path: str):
         """