Add parameter inference notes

Author: forsyth2

tests/integration/template_weekly_legacy_3.0.0_comprehensive_v3.cfg

@@ -4,7 +4,12 @@ constraint = "#expand constraint#"
 dry_run = "#expand dry_run#"
 environment_commands = "#expand environment_commands#"
 fail_on_dependency_skip = True
-infer_path_parameters = False
+# This setting does not support backwards compatibility.
+# Its purpose is specifically to call attention to parameters
+# that zppy would otherwise just infer, perhaps making an incorrect inference.
+# Therefore, it is expected that a user using this setting would want to get an error
+# noting new parameters to add explicitly to their cfg.
+# infer_path_parameters = False
 infer_section_parameters = False
 input = #expand user_input_v3#/E3SMv3/#expand case_name#
 input_subdir = archive/atm/hist

zppy/defaults/default.ini

@@ -31,6 +31,9 @@ grid = string(default="")
 # These two parameters enable zppy to infer path or section parameters.
 # This allows users to set fewer parameters, but with the risk of zppy choosing incorrect values for them.
 # Set to False for more transparency in path or section defintions.
+# Please note `infer_path_parameters = False` does NOT support backwards compatibility.
+# The expectation is the user will want an error message describing parameters they haven't explicitly defined.
+# So, as new parameters get added in successive zppy versions, they can update their cfgs accordingly.
 infer_path_parameters = boolean(default=True)
 infer_section_parameters = boolean(default=True)
 # The directory to be post-processed