Skip to content

Commit 59c724d

Browse files
committed
docs: more words about the public api
1 parent 563eacf commit 59c724d

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

doc/api.rst

+10-4
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,17 @@ If you want to access the data that coverage.py has collected, the
3737
:class:`coverage.CoverageData` class provides an API to read coverage.py data
3838
files.
3939

40-
.. note::
40+
.. warning::
4141

42-
Only the documented portions of the API are supported. Other names you may
43-
find in modules or objects can change their behavior at any time. Please
44-
limit yourself to documented methods to avoid problems.
42+
Only the published documented portions of the API are supported. Other
43+
names you may find in modules or objects can change their behavior at any
44+
time. Please limit yourself to documented methods to avoid problems.
45+
46+
All internal code in coverage.py has docstrings; this does not make them
47+
part of the public supported API. Many internal names have no leading
48+
underscore; this does not make them part of the public supported API. If
49+
classes or functions are not documented in this published documentation,
50+
they are not supported.
4551

4652
For more intensive data use, you might want to access the coverage.py database
4753
file directly. The schema is subject to change, so this is for advanced uses

0 commit comments

Comments
 (0)