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 /Doc/whatsnew | |
parent | b52c753e0fb8b87c7a0e3f1c72acd18327d8d16b (diff) | |
download | cpython-164e2c31c073b5fd8d25b3432a5e5c721f747393.zip cpython-164e2c31c073b5fd8d25b3432a5e5c721f747393.tar.gz cpython-164e2c31c073b5fd8d25b3432a5e5c721f747393.tar.bz2 |
gh-117225: Document colour use in `doctest` (#118268)
Diffstat (limited to 'Doc/whatsnew')
-rw-r--r-- | Doc/whatsnew/3.13.rst | 16 |
1 files changed, 15 insertions, 1 deletions
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 ----- |