summaryrefslogtreecommitdiff
path: root/doc/api.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2021-11-13 19:00:51 -0500
committerNed Batchelder <ned@nedbatchelder.com>2021-11-14 07:44:57 -0500
commit342e7da2941ae5291f1a94b6ad66ce489f6985fe (patch)
tree47dc5f4db2d314c4e0c8051e705222ae76899431 /doc/api.rst
parentb8eeb82bcc7350aade99844e8730e69120e9bed0 (diff)
downloadpython-coveragepy-git-342e7da2941ae5291f1a94b6ad66ce489f6985fe.tar.gz
docs: document the exceptions
... and make some of them private.
Diffstat (limited to 'doc/api.rst')
-rw-r--r--doc/api.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/api.rst b/doc/api.rst
index 855e3ec6..f5112165 100644
--- a/doc/api.rst
+++ b/doc/api.rst
@@ -9,10 +9,10 @@ Coverage.py API
There are a few different ways to use coverage.py programmatically.
-The API to coverage.py is in a module called `coverage`.
-Most of the interface is in the :class:`coverage.Coverage` class. Methods on
-the Coverage object correspond roughly to operations available in the command
-line interface. For example, a simple use would be::
+The API to coverage.py is in a module called :mod:`coverage`. Most of the
+interface is in the :class:`coverage.Coverage` class. Methods on the Coverage
+object correspond roughly to operations available in the command line
+interface. For example, a simple use would be::
import coverage
@@ -48,6 +48,7 @@ only. :ref:`dbschema` explains more.
:maxdepth: 1
api_coverage
+ api_exceptions
api_module
api_plugin
api_coveragedata