[Feature request]: Arbitrary Configuration Annotations Via comment Field

[TimothyWillard]

Label

config, enhancement

Priority Label

low priority

Is your feature request related to a problem? Please describe.

When working on configurations, especially when multiple individuals are involved, it can be challenging to add notes/annotations to the configuration. The configuration writer does not support adding comments so currently individuals will manually add comments to configuration files after the configuration writer generates a configuration YAML. These annotations are lost when running the configuration writer again.

Is your feature request related to a new application, scenario round, pathogen? Please describe.

No response

Describe the solution you'd like

Allow adding a comment (or similarly named, not tied to this name) field to any part of the configuration YAML files. This would allow the configuration writer to add comments as keys in a YAML file and PyYAML would be able to preserve these comments as they move through flepiMoP. These fields would not be used for any actual work by the pipeline as these fields would be too unstructured to derive value from, just need to add enough support for them so they 1) don't cause an error in flepiMoP due to an unexpected key or 2) pass them through for functionality in the pipeline that produces another configuration YAML.