summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorBrett Cannon <bcannon@gmail.com>2010-07-23 11:31:31 (GMT)
committerBrett Cannon <bcannon@gmail.com>2010-07-23 11:31:31 (GMT)
commit3a4e50cb7e4646b046f98e67f749cdcfecf7d75a (patch)
tree8acc6f0bd94fe4a450ce5b922ea34542f457b306 /Doc
parent102d11a6d6f972c5d9071f0c9a13204040ec39c8 (diff)
downloadcpython-3a4e50cb7e4646b046f98e67f749cdcfecf7d75a.zip
cpython-3a4e50cb7e4646b046f98e67f749cdcfecf7d75a.tar.gz
cpython-3a4e50cb7e4646b046f98e67f749cdcfecf7d75a.tar.bz2
Document the fact that the 'test' package is meant only for use by Python
itself and not by others. Closes issue 9255.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/test.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/library/test.rst b/Doc/library/test.rst
index 3b9ad10..d6ff734 100644
--- a/Doc/library/test.rst
+++ b/Doc/library/test.rst
@@ -5,6 +5,13 @@
:synopsis: Regression tests package containing the testing suite for Python.
.. sectionauthor:: Brett Cannon <brett@python.org>
+.. note::
+ The :mod:`test` package is meant for internal use by Python only. It is
+ documented for the benefit of the core developers of Python. Any use of
+ this package outside of Python's standard library is discouraged as code
+ mentioned here can change or be removed without notice between releases of
+ Python.
+
The :mod:`test` package contains all regression tests for Python as well as the
modules :mod:`test.support` and :mod:`test.regrtest`.