From eedab79f447a089765e36bef1b7ac5b762d54ff7 Mon Sep 17 00:00:00 2001 From: Ben Nemec Date: Tue, 12 Mar 2019 15:21:42 +0000 Subject: [PATCH] Add note to docs about CLI opts and config files CLI opts can also be read from file, so once an option is registered for CLI use it doesn't need to be registered again to be usable in a config file. Add a note in the Registering Options section that explicitly explains this behavior. Change-Id: Ib75b5c314b96ec4c46f94e2847016a953433f480 --- doc/source/reference/defining.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/source/reference/defining.rst b/doc/source/reference/defining.rst index 59d80d56..d8e18660 100644 --- a/doc/source/reference/defining.rst +++ b/doc/source/reference/defining.rst @@ -112,7 +112,11 @@ class which uses the option: An option may optionally be made available via the command line. Such options must be registered with the config manager before the command line is parsed -(for the purposes of --help and CLI arg validation): +(for the purposes of --help and CLI arg validation). + +Note that options registered for CLI use do not need to be registered again for +use from other config sources, such as files. CLI options can be read from +either the CLI or from the other enabled config sources. .. code-block:: python