diff options
| -rw-r--r-- | coverage/control.py | 4 | ||||
| -rw-r--r-- | doc/api.rst | 5 | ||||
| -rw-r--r-- | doc/whatsnew5x.rst | 3 |
3 files changed, 12 insertions, 0 deletions
diff --git a/coverage/control.py b/coverage/control.py index 28d57535..1de0e28f 100644 --- a/coverage/control.py +++ b/coverage/control.py @@ -73,6 +73,10 @@ class Coverage(object): cov.stop() cov.html_report(directory='covhtml') + Note: in keeping with Python custom, names starting with underscore are + not part of the public API. They might stop working at any point. Please + limit yourself to documented methods to avoid problems. + """ # The stack of started Coverage instances. diff --git a/doc/api.rst b/doc/api.rst index 268f9888..f344972a 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -34,6 +34,11 @@ If you want to access the data that coverage.py has collected, the :class:`coverage.CoverageData` class provides an API to read coverage.py data files. +.. Note:: + Only the documented portions of the API are supported. Other names you may + find in modules or objects can change their behavior at any time. Please + limit yourself to documented methods to avoid problems. + For more intensive data use, you might want to access the coverage.py database file directly. The schema is subject to change, so this is for advanced uses only. :ref:`dbschema` explains more. diff --git a/doc/whatsnew5x.rst b/doc/whatsnew5x.rst index 4724dee7..5f21a5d4 100644 --- a/doc/whatsnew5x.rst +++ b/doc/whatsnew5x.rst @@ -48,6 +48,9 @@ Backward Incompatibilities configuration of the Coverage object. Now they no longer do. The arguments affect the operation of the method, but do not persist. +- Many internal attributes and functions were changed. These were not part of + the public supported API. If your code used them, it might now stop working. + New Features ------------ |