Change test.support docs to be more specific about the nature of this module.
diff --git a/Doc/library/test.rst b/Doc/library/test.rst
index 9d02b0a..c27ee08 100644
--- a/Doc/library/test.rst
+++ b/Doc/library/test.rst
@@ -187,19 +187,24 @@
regression tests.
-:mod:`test.support` --- Utility functions for tests
-===================================================
+:mod:`test.support` --- Utilities for the Python test suite
+===========================================================
.. module:: test.support
- :synopsis: Support for Python regression tests.
+ :synopsis: Support for Python's regression test suite.
The :mod:`test.support` module provides support for Python's regression
-tests.
+test suite.
+
+.. note::
+ :mod:`test.support` is not a public module. It is documented here to help
+ Python developers write tests. The API of this module is subject to change
+ without backwards compatibility concerns between releases.
+
This module defines the following exceptions:
-
.. exception:: TestFailed
Exception to be raised when a test fails. This is deprecated in favor of
@@ -213,8 +218,8 @@
network connection) is not available. Raised by the :func:`requires`
function.
-The :mod:`test.support` module defines the following constants:
+The :mod:`test.support` module defines the following constants:
.. data:: verbose
@@ -233,8 +238,8 @@
Set to a name that is safe to use as the name of a temporary file. Any
temporary file that is created should be closed and unlinked (removed).
-The :mod:`test.support` module defines the following functions:
+The :mod:`test.support` module defines the following functions:
.. function:: forget(module_name)