Preserve Yaml structure

[TenKenZero]

Currently, the application is changing the order of the YAML file's content when it introduces the description block.

This is the original YAML file:

This is the modified YAML with the documentation generated by the app:

We need to add the description section after the name one and keep the other sections in the same order they had before running the app.

[munish7771]

Looks like an issue with yaml.safe_load() call to read yaml file into python dict.

There are two possible resolutions here -

1. use yaml.load(), which preserves the order in yaml file. But should not be used with untrusted data.
2. creating own implementation of yaml.safe_load to preserve the order of yaml file.

Going with the 2nd approach as it looks safe.

[munish7771]

So, the issue was while writing to yaml file. Introduced a new dependency ruamel.yaml just for write.

ruamel.yaml - to write to yaml file, preserves the order of keys.
PyYaml - to read the yaml file (existing flow). Wanted to remove this and use ruamel.yaml but don't feel confident since there are no test cases to validate.

[munish7771]

@TenKenZero can we close this as well? since its fixed now.

[TenKenZero]

Yes!
I'll do