8000 docs(fix): use fully-qualified names in autodoc directives (#1882) · shenanigansd/coveragepy@ea48124 · GitHub
[go: up one dir, main page]
Skip to content

Commit ea48124

Browse files
AA-Turnernedbat
AA-Turner
and
nedbat
authored
docs(fix): use fully-qualified names in autodoc directives (nedbat#1882)
* Use fully-qualified names in autodoc directives * docs: thanks, Adam! --------- Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
1 parent 39114d5 commit ea48124

6 files changed

+10
-23
lines changed

‎CONTRIBUTORS.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Other contributions, including writing code, updating docs, and submitting
55
useful bug reports, have been made by:
66

77
Abdeali Kothari
8+
Adam Turner
89
Adi Roiban
910
Agbonze O. Jeremiah
1011
Albertas Agejevas

‎doc/api_coverage.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,7 @@
66
The Coverage class
77
------------------
88

9-
.. module:: coverage
10-
:noindex:
11-
12-
.. autoclass:: Coverage
9+
.. autoclass:: coverage.Coverage
1310
:members:
1411
:exclude-members: sys_info
1512
:special-members: __init__

‎doc/api_coveragedata.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ The CoverageData class
88

99
.. versionadded:: 4.0
1010

11-
.. module:: coverage
12-
:no-index:
13-
14-
.. autoclass:: CoverageData
11+
.. autoclass:: coverage.CoverageData
1512
:members:
1613
:special-members: __init__

‎doc/api_exceptions.rst

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,6 @@
66
Coverage exceptions
77
-------------------
88

9-
.. module:: coverage.exceptions
10-
11-
.. autoclass:: CoverageException
12-
139
.. automodule:: coverage.exceptions
14-
:no-index:
1510
:members:
16-
:exclude-members: CoverageException
11+
:member-order: bysource

‎doc/api_module.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ available by name.
2626

2727
A string with the version of coverage.py, for example, ``"5.0b2"``.
2828

29-
.. autoclass:: CoverageException
29+
.. autoexception:: coverage.CoverageException
3030

3131

3232
Starting coverage.py automatically
@@ -35,4 +35,4 @@ Starting coverage.py automatically
3535
This function is used to start coverage measurement automatically when Python
3636
starts. See :ref:`subprocess` for details.
3737

38-
.. autofunction:: process_startup
38+
.. autofunction:: coverage.process_startup

‎doc/api_plugin.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,33 +9,30 @@ Plug-in classes
99

1010
.. automodule:: coverage.plugin
1111

12-
.. module:: coverage
13-
:no-index:
14-
1512
The CoveragePlugin class
1613
------------------------
1714

18-
.. autoclass:: CoveragePlugin
15+
.. autoclass:: coverage.CoveragePlugin
1916
:members:
2017
:member-order: bysource
2118

2219
The FileTracer class
2320
--------------------
2421

25-
.. autoclass:: FileTracer
22+
.. autoclass:: coverage.FileTracer
2623
:members:
2724
:member-order: bysource
2825

2926
The FileReporter class
3027
----------------------
3128

32-
.. autoclass:: FileReporter
29+
.. autoclass:: coverage.FileReporter
3330
:members:
3431
:member-order: bysource
3532

3633
The CodeRegion class
3734
--------------------
3835

39-
.. autoclass:: CodeRegion
36+
.. autoclass:: coverage.CodeRegion
4037
:members:
4138
:member-order: bysource

0 commit comments

Comments
 (0)
0