diff --git a/README.rst b/README.rst index 4da9d46..29ba6f8 100644 --- a/README.rst +++ b/README.rst @@ -568,15 +568,14 @@ Design choices: file (eg. short args like -x would be excluded). Also, that way config keys are automatically documented whenever the command line args are documented in the help message. -5. > don't force users to put config file settings in the right .ini - [sections]. This doesn't have a clear benefit since all options are - command-line settable, and so have a globally unique key anyway. - Enforcing sections just makes things harder for the user and adds - complexity to the implementation. - This design choice was preventing configargparse from integrating - with common Python project config files like setup.cfg or pyproject.toml. - This is why some additional parser classes were added that parse only - a subset of the values defined in INI or TOML config files. +5. > don't force users to put config file settings in the right .ini [sections]. + This doesn't have a clear benefit since all options are command-line settable, + and so have a globally unique key anyway. + Enforcing sections just makes things harder for the user and adds complexity to the implementation. + NOTE: This design choice was preventing configargparse from integrating with common Python project + config files like setup.cfg or pyproject.toml, + so additional parser classes were added that parse only a subset of the values defined in INI or + TOML config files. 6. if necessary, config-file-only args can be added later by implementing a separate add method and using the namespace arg as in appsettings_v0.5