diff options
| author | Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> | 2024-05-01 18:25:11 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-01 18:25:11 (GMT) |
| commit | 164e2c31c073b5fd8d25b3432a5e5c721f747393 (patch) | |
| tree | 83b0a0eaebb4571e71b5ce3c2701799d278d19c4 | |
| parent | b52c753e0fb8b87c7a0e3f1c72acd18327d8d16b (diff) | |
| download | cpython-164e2c31c073b5fd8d25b3432a5e5c721f747393.zip cpython-164e2c31c073b5fd8d25b3432a5e5c721f747393.tar.gz cpython-164e2c31c073b5fd8d25b3432a5e5c721f747393.tar.bz2 | |
gh-117225: Document colour use in `doctest` (#118268)
| -rw-r--r-- | Doc/using/cmdline.rst | 12 | ||||
| -rw-r--r-- | Doc/whatsnew/3.13.rst | 16 |
2 files changed, 25 insertions, 3 deletions
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index 295e3fb..1f5d02d 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -632,11 +632,11 @@ behavior can be controlled by setting different environment variables. Setting the environment variable ``TERM`` to ``dumb`` will disable color. -If the environment variable ``FORCE_COLOR`` is set, then color will be +If the |FORCE_COLOR|_ environment variable is set, then color will be enabled regardless of the value of TERM. This is useful on CI systems which aren’t terminals but can still display ANSI escape sequences. -If the environment variable ``NO_COLOR`` is set, Python will disable all color +If the |NO_COLOR|_ environment variable is set, Python will disable all color in the output. This takes precedence over ``FORCE_COLOR``. All these environment variables are used also by other tools to control color @@ -645,6 +645,14 @@ output. To control the color output only in the Python interpreter, the precedence over ``NO_COLOR``, which in turn takes precedence over ``FORCE_COLOR``. +.. Apparently this how you hack together a formatted link: + +.. |FORCE_COLOR| replace:: ``FORCE_COLOR`` +.. _FORCE_COLOR: https://force-color.org/ + +.. |NO_COLOR| replace:: ``NO_COLOR`` +.. _NO_COLOR: https://no-color.org/ + Options you shouldn't use ~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst index 5a16955..d67df81 100644 --- a/Doc/whatsnew/3.13.rst +++ b/Doc/whatsnew/3.13.rst @@ -100,10 +100,18 @@ Improved Error Messages * The interpreter now colorizes error messages when displaying tracebacks by default. This feature can be controlled via the new :envvar:`PYTHON_COLORS` environment - variable as well as the canonical ``NO_COLOR`` and ``FORCE_COLOR`` environment + variable as well as the canonical |NO_COLOR|_ and |FORCE_COLOR|_ environment variables. See also :ref:`using-on-controlling-color`. (Contributed by Pablo Galindo Salgado in :gh:`112730`.) +.. Apparently this how you hack together a formatted link: + +.. |FORCE_COLOR| replace:: ``FORCE_COLOR`` +.. _FORCE_COLOR: https://force-color.org/ + +.. |NO_COLOR| replace:: ``NO_COLOR`` +.. _NO_COLOR: https://no-color.org/ + * A common mistake is to write a script with the same name as a standard library module. When this results in errors, we now display a more helpful error message: @@ -439,6 +447,12 @@ doctest :attr:`doctest.TestResults.skipped` attributes. (Contributed by Victor Stinner in :gh:`108794`.) +* Color is added to the output by default. + This can be controlled via the new :envvar:`PYTHON_COLORS` environment + variable as well as the canonical |NO_COLOR|_ and |FORCE_COLOR|_ environment + variables. See also :ref:`using-on-controlling-color`. + (Contributed by Hugo van Kemenade in :gh:`117225`.) + email ----- |