search

loganasherjones / yapconf

Yet Another Python Configuration
http://yapconf.readthedocs.io/en/stable/
MIT License
18 stars 4 forks source link

Documentation inside configuration files #81

Open loganasherjones opened 6 years ago

loganasherjones commented 6 years ago

This could only work for yaml files currently, but it would be amazing to actually write along side the configuration file itself, a description which, well, describes the configuration item.

I don't think ruamel.yaml nor PyYAML supports this, but I haven't checked their issues. It might be as simple as adding a flag and including a description, but I doubt it.

loganasherjones commented 6 years ago

Looks like this is possible with ruamel.yaml http://yaml.readthedocs.io/en/latest/detail.html#adding-replacing-comments