cpython (3.2): Change test.support docs to be more specific about the nature of this module.

http://hg.python.org/cpython/rev/4bcfb24c7f1f changeset: 71626:4bcfb24c7f1f branch: 3.2 parent: 71624:a8aa918041c2 user: Georg Brandl <georg@python.org> date: Sat Jul 30 09:00:48 2011 +0200 summary: Change test.support docs to be more specific about the nature of this module. files: Doc/library/test.rst | 19 ++++++++++++------- 1 files changed, 12 insertions(+), 7 deletions(-) diff --git a/Doc/library/test.rst b/Doc/library/test.rst --- 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,9 +218,9 @@ network connection) is not available. Raised by the :func:`requires` function. + The :mod:`test.support` module defines the following constants: - .. data:: verbose :const:`True` when verbose output is enabled. Should be checked when more @@ -233,9 +238,9 @@ 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: - .. function:: forget(module_name) Remove the module named *module_name* from ``sys.modules`` and delete any -- Repository URL: http://hg.python.org/cpython
participants (1)
-
georg.brandl