diff options
| author | Bernát Gábor <bgabor8@bloomberg.net> | 2021-08-10 22:15:59 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-10 22:15:59 +0100 |
| commit | 2890f888f50d1402cc172cd70efa190787c42853 (patch) | |
| tree | c5a1e89cb75b9e76ec82a090810f1ced3974d242 | |
| parent | ae97ef5d61c3b56c21009224ef732218b48947d8 (diff) | |
| download | tox-git-2890f888f50d1402cc172cd70efa190787c42853.tar.gz | |
Clarify documentation for --runner (#2151)
Signed-off-by: Bernát Gábor <gaborjbernat@gmail.com>
| -rw-r--r-- | docs/changelog/2004.doc.rst | 1 | ||||
| -rw-r--r-- | docs/cli_interface.rst | 2 | ||||
| -rw-r--r-- | src/tox/config/cli/parse.py | 10 | ||||
| -rw-r--r-- | src/tox/session/state.py | 2 |
4 files changed, 13 insertions, 2 deletions
diff --git a/docs/changelog/2004.doc.rst b/docs/changelog/2004.doc.rst new file mode 100644 index 00000000..be22fbb9 --- /dev/null +++ b/docs/changelog/2004.doc.rst @@ -0,0 +1 @@ +Fix :ref:`--runner <tox---runner>` is missing default value and documentation unclear - by :user:`gaborbernat`. diff --git a/docs/cli_interface.rst b/docs/cli_interface.rst index 578c3505..7bbc50fc 100644 --- a/docs/cli_interface.rst +++ b/docs/cli_interface.rst @@ -1,3 +1,3 @@ .. sphinx_argparse_cli:: :module: tox.config.cli.parse - :func: _get_parser + :func: _get_parser_doc diff --git a/src/tox/config/cli/parse.py b/src/tox/config/cli/parse.py index 498bf5fa..fc717bec 100644 --- a/src/tox/config/cli/parse.py +++ b/src/tox/config/cli/parse.py @@ -62,6 +62,16 @@ def _get_parser() -> ToxParser: return tox_parser +def _get_parser_doc() -> ToxParser: + # trigger register of tox env types (during normal run we call this later to handle plugins) + from tox.plugin.manager import MANAGER # pragma: no cover + from tox.tox_env.register import REGISTER # pragma: no cover + + REGISTER._register_tox_env_types(MANAGER) # pragma: no cover + + return _get_parser() # pragma: no cover + + __all__ = ( "get_options", "Handlers", diff --git a/src/tox/session/state.py b/src/tox/session/state.py index 60f9d5b7..5661daa3 100644 --- a/src/tox/session/state.py +++ b/src/tox/session/state.py @@ -127,7 +127,7 @@ def tox_add_option(parser: "ToxParser") -> None: parser.add_argument( "--runner", dest="default_runner", - help="default execute", + help="the tox run engine to use when not explicitly stated in tox env configuration", default=REGISTER.default_run_env, choices=list(REGISTER.run_envs), ) |