mirrors/cpython
0
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2024-11-24 18:34:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

Change test.support docs to be more specific about the nature of this module.

Browse Source
This commit is contained in:
Georg Brandl 2011-07-30 09:00:48 +02:00
parent 7bd081c117
commit eea6cda91a
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Doc/library/test.rst
View File

@ -187,19 +187,24 @@ executing :program:`rt.bat` from your :file:`PCBuild` directory will run all
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 @@ This module defines the following exceptions:
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 @@ The :mod:`test.support` module defines the following constants:
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)