Skip to content

Commit

Permalink
Mention colour control in docs for doctest, traceback and unittest
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk committed Nov 24, 2024
1 parent 5a1de7c commit d2b0e29
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
4 changes: 4 additions & 0 deletions Doc/library/doctest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,10 @@ examples of doctests in the standard Python test suite and libraries.
Especially useful examples can be found in the standard test file
:file:`Lib/test/test_doctest/test_doctest.py`.

.. versionadded:: 3.13
Output is colorized by default and can be
:ref:`controlled using environment variables <using-on-controlling-color>`.


.. _doctest-simple-testmod:

Expand Down
4 changes: 4 additions & 0 deletions Doc/library/traceback.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ The module's API can be divided into two parts:
necessary for later formatting without holding references to actual exception
and traceback objects.

.. versionadded:: 3.13
Output is colorized by default and can be
:ref:`controlled using environment variables <using-on-controlling-color>`.


Module-Level Functions
----------------------
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/unittest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,6 @@ test runner
a textual interface, or return a special value to indicate the results of
executing the tests.

Output is in color by default and can be
:ref:`controlled using environment variables <using-on-controlling-color>`.

.. seealso::

Module :mod:`doctest`
Expand Down Expand Up @@ -200,6 +197,9 @@ For a list of all the command-line options::
In earlier versions it was only possible to run individual test methods and
not modules or classes.

.. versionadded:: 3.14
Output is colorized by default and can be
:ref:`controlled using environment variables <using-on-controlling-color>`.

Command-line options
~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit d2b0e29

Please sign in to comment.