From 1b9c2250bbb45bf232174446ee74caf28a9ff9d2 Mon Sep 17 00:00:00 2001
From: Matt Bogosian <eb3f73+github+com@yaymail.com>
Date: Thu, 7 Sep 2023 16:04:05 -0500
Subject: [PATCH] Providing example to make CLI help more helpful for
 -x,--override (#3119)

---
 docs/changelog/3119.bugfix.rst | 1 +
 docs/config.rst                | 2 +-
 docs/faq.rst                   | 4 ++--
 src/tox/config/loader/api.py   | 5 +++--
 4 files changed, 7 insertions(+), 5 deletions(-)
 create mode 100644 docs/changelog/3119.bugfix.rst

diff --git a/docs/changelog/3119.bugfix.rst b/docs/changelog/3119.bugfix.rst
new file mode 100644
index 000000000..2f1d78e27
--- /dev/null
+++ b/docs/changelog/3119.bugfix.rst
@@ -0,0 +1 @@
+- Provide example to make CLI help more helpful for -x,--override - by :user:`posita`. (:issue:`3119`)
diff --git a/docs/config.rst b/docs/config.rst
index 1e9d3805a..7b2d05ecc 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -1045,7 +1045,7 @@ Set CLI flags via environment variables
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 All CLI flags can be set via environment variables too, the naming convention here is ``TOX_<option>``. E.g.
 ``TOX_WORKDIR`` sets the ``--workdir`` flag, or ``TOX_OVERRIDE`` sets the ``--override`` flag. For flags accepting more
-than one arguments (such as override) use the ``;`` character to separate these values:
+than one argument, use the ``;`` character to separate these values:
 
 .. code-block:: bash
 
diff --git a/docs/faq.rst b/docs/faq.rst
index ec5dd7030..8d5a2a9e6 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -55,8 +55,8 @@ Here is a non-exhaustive list of these.
   changed via ``TOX_CONFIG_FILE`` environment variable).
 - All tox defaults can now be changed via an environment variable: ``TOX_`` prefix followed by the settings key,
   e.g. ``TOX_PACKAGE=wheel``.
-- Any configuration can be overwritten via the CLI ``-x`` or ``--override`` flag, e.g.
-  ``tox run -e py311  -x testenv:py310.package=editable`` would force the packaging of environment ``py311`` to be an
+- Any configuration can be overridden via the CLI ``-x`` or ``--override`` flag, e.g.
+  ``tox run -e py311 -x testenv:py311.package=editable`` would force the packaging of environment ``py311`` to be an
   editable install independent what's in the configuration file.
 - :ref:`basepython` is now a list, the first successfully detected python will be used to generate python environment.
 - We now have support for inline tox plugins via the ``toxfile.py`` at the root of your project. At a later time this
diff --git a/src/tox/config/loader/api.py b/src/tox/config/loader/api.py
index 5ece578e4..978f49f75 100644
--- a/src/tox/config/loader/api.py
+++ b/src/tox/config/loader/api.py
@@ -177,14 +177,15 @@ def build(  # noqa: PLR0913
 
 @impl
 def tox_add_option(parser: ToxParser) -> None:
+    override_short_option = "-x"
     parser.add_argument(
-        "-x",
+        override_short_option,
         "--override",
         action="append",
         type=Override,
         default=[],
         dest="override",
-        help="configuration override(s)",
+        help=f"configuration override(s), e.g., {override_short_option} testenv:pypy3.ignore_errors=True",
     )