[Python-checkins] r83072 - in python/branches/py3k: Doc/library/test.rst Misc/NEWS

brett.cannon python-checkins at python.org
Fri Jul 23 13:31:32 CEST 2010


Author: brett.cannon
Date: Fri Jul 23 13:31:31 2010
New Revision: 83072

Log:
Document the fact that the 'test' package is meant only for use by Python
itself and not by others.

Closes issue 9255.


Modified:
   python/branches/py3k/Doc/library/test.rst
   python/branches/py3k/Misc/NEWS

Modified: python/branches/py3k/Doc/library/test.rst
==============================================================================
--- python/branches/py3k/Doc/library/test.rst	(original)
+++ python/branches/py3k/Doc/library/test.rst	Fri Jul 23 13:31:31 2010
@@ -5,6 +5,13 @@
    :synopsis: Regression tests package containing the testing suite for Python.
 .. sectionauthor:: Brett Cannon <brett at 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`.

Modified: python/branches/py3k/Misc/NEWS
==============================================================================
--- python/branches/py3k/Misc/NEWS	(original)
+++ python/branches/py3k/Misc/NEWS	Fri Jul 23 13:31:31 2010
@@ -1655,6 +1655,9 @@
 Documentation
 ------------
 
+- Issue 9255: Document that the 'test' package is meant for internal Python use
+  only.
+
 - A small wsgi server was added as Tools/scripts/serve.py, and is used to
   implement a local documentation server via 'make serve' in the doc directory.
 


More information about the Python-checkins mailing list