pythongh-112730: Update docs for colour env vars (python#112837)

AlexWaygood · Dec 14, 2023 · 12f0bbd · 12f0bbd
1 parent 29f7eb4
commit 12f0bbd
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
@@ -610,7 +610,9 @@ Miscellaneous options
    .. versionadded:: 3.13
       The ``-X presite`` option.
 
-Controlling Color
+.. _using-on-controlling-color:
+
+Controlling color
 ~~~~~~~~~~~~~~~~~
 
 The Python interpreter is configured by default to use colors to highlight
@@ -1133,6 +1135,7 @@ conflict.
 
    If this variable is set to ``1``, the interpreter will colorize various kinds
    of output. Setting it to ``0`` deactivates this behavior.
+   See also :ref:`using-on-controlling-color`.
 
    .. versionadded:: 3.13
 

diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
@@ -91,7 +91,8 @@ 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
-  variables. (Contributed by Pablo Galindo Salgado in :gh:`112730`.)
+  variables. See also :ref:`using-on-controlling-color`.
+  (Contributed by Pablo Galindo Salgado in :gh:`112730`.)
 
 Other Language Changes
 ======================

diff --git a/Misc/python.man b/Misc/python.man
@@ -601,6 +601,9 @@ show how long each import takes. This is exactly equivalent to setting
 .IP PYTHONBREAKPOINT
 If this environment variable is set to 0, it disables the default debugger. It
 can be set to the callable of your debugger of choice.
+.IP PYTHON_COLORS
+If this variable is set to 1, the interpreter will colorize various kinds of
+output. Setting it to 0 deactivates this behavior.
 .SS Debug-mode variables
 Setting these variables only has an effect in a debug build of Python, that is,
 if Python was configured with the