Skip to content

Commit 39f9843

Browse files
committed
test(core): document intentional scope limits of api docs consistency check
1 parent 1438c20 commit 39f9843

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

‎cuda_core/tests/test_api_docs_consistency.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,22 @@
88
(``graph``, ``system``, ``texture``, ``utils``, and any added later) discovered
99
automatically from ``cuda.core.__path__``. For each public namespace, exported
1010
``__all__`` names must appear somewhere in ``cuda_core/docs/source``.
11+
12+
The enforced direction is deliberately one-way (public export -> documented).
13+
This is intentionally a *name-presence* check, and it does not verify:
14+
15+
- the reverse direction (documented -> exported): documenting a private or
16+
internal symbol on any page is allowed, so a documented name is never
17+
required to be public;
18+
- signatures, docstrings, parameter lists, or rendered output: only that each
19+
exported name appears as a documented entry;
20+
- whether an entry is marked ``:no-index:`` or deprecated: such entries still
21+
count as documented;
22+
- class members or attributes nested below the namespace level: only top-level
23+
names of each namespace are matched (entries deeper than
24+
``<subpackage>.<name>`` are ignored);
25+
- docs outside the top-level ``docs/source/*.rst`` files: nested pages are not
26+
scanned.
1127
"""
1228

1329
import collections

0 commit comments

Comments
 (0)