search

loganasherjones / yapconf

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

Changing README examples #87

Closed hazmat345 closed 5 years ago

hazmat345 commented 6 years ago

There was some confusion regarding the info in the docs and readme. It was brought up that some fairly important caveats (such as snake-casing environment variable names) are only mentioned in the docs, so someone just looking at the readme might be surprised.

I reworked the order / content of the examples slightly. Instead of introducing file, environment variable, and multiple source priority in the first example I split them out into several. This results in some slight code duplication (defining the spec and the final prints) but I think the tradeoff of having each example be standalone (so you can copy/paste into a file on your machine) is worth it.

hazmat345 commented 5 years ago

@loganasherjones can you take a look at this?