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 /coverage/control.py | |
parent | 17eb994a05854b79dfb2ef810afcd736816fc431 (diff) | |
download | python-coveragepy-git-3875113f0e8a8ec333b61000fbe038a2725903f4.tar.gz |
Be clear about the documented parts of the API.
Diffstat (limited to 'coverage/control.py')
-rw-r--r-- | coverage/control.py | 4 |
1 files changed, 4 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. |