search

loganasherjones / yapconf

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

Doc update for boolean CLI #86

Open hazmat345 opened 6 years ago

hazmat345 commented 6 years ago

I think there's a discrepency between the docs here and behavior.

Boolean items will add special flags to the command-line based on their defaults. If you have a default set to True then a --no-{item_name} flag will get added. If the default is False then a --{{item_name}} will get added as an argument. If no default is specified, then both will be added as mutually exclusive arguments.

This seems to imply that passing the 'redundant' flag on the cli (the one that corresponds to the default value) would result in an error. However, that doesn't seem to be what happens.

loganasherjones commented 6 years ago

That is correct. The docs are wrong. Both flags get added to the CLI args.