diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2019-12-16 19:23:26 -0500 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2019-12-16 19:23:26 -0500 |
| commit | 3875113f0e8a8ec333b61000fbe038a2725903f4 (patch) | |
| tree | a9a1c98a81c19fe0275eeb329c44fb057ffcf2ea /doc | |
| parent | 17eb994a05854b79dfb2ef810afcd736816fc431 (diff) | |
| download | python-coveragepy-git-3875113f0e8a8ec333b61000fbe038a2725903f4.tar.gz | |
Be clear about the documented parts of the API.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api.rst | 5 | ||||
| -rw-r--r-- | doc/whatsnew5x.rst | 3 |
2 files changed, 8 insertions, 0 deletions
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 ------------ |