Repository navigation
docs: add pcapkit.__version__ entry and the missing corekit.enum page - #919
Conversation
- Documented pcapkit.__version__ under a new "Package Metadata" section on the pcapkit module page, next to how other top-level pcapkit attributes are documented; it had no API entry, only prose mentions. - Added docs/source/pcapkit/corekit/enum.rst for pcapkit.corekit.enum, which had no page at all, so EnumLookup/EnumRegistry were undocumented and every :class:`~pcapkit.corekit.enum.*` reference in the convention docs resolved to nothing. Wired into corekit/index.rst's toctree. - Audited every :file: role under docs/source, pcapkit/ and tests/ (498 occurrences, 210 unique targets); fixed the 7 that named a stale or wrong path: two abbreviated pcapkit/protocols/*.py citations missing their directory prefix, and five references in a just-merged test file still pointing at conventions.rst's pre-move location. Verified against a fresh HTML build: EnumLookup/EnumRegistry get real id anchors and the conventions.rst cross-references into them now render as real hrefs. Sphinx warnings: 58 on origin/main, 61 here (+3, all "duplicate object description" for explicitly-redeclared private methods, the same pattern already used on Info.__init_subclass__).
|
GOOD TO GO — cross-review verdict at head Independently re-derived on the built tree, not from warning counts: the docs build exits 0 on both trees; the warning delta is exactly +3, all Three corrections to the numbers, none blocking, all measured by me:
CI at this head: 53 CheckRuns pass, 0 fail, the five |
Please follow the guide below
make pylint,make mypy,make isort)make testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
Closes #902.
pcapkit.__version__: added under a new "Package Metadata" section ondocs/source/pcapkit/index.rst, matching where other top-levelpcapkitdata lives -- it had no API entry, only prose mentions.
pcapkit.corekit.enumhad no doc page at all: addeddocs/source/pcapkit/corekit/enum.rst(shape matchesmodule.rst/field.rst)and wired it into
corekit/index.rst's toctree.EnumLookup/EnumRegistrynow get real
idanchors, and every:class:~pcapkit.corekit.enum.*``reference in
contributing/conventions.rstresolves to a real `href` --verified against a built HTML tree, not a warning count, since `conf.py`
sets no `nitpicky` and the build uses no `-W`.
:file:audit: swept 498 occurrences (210 unique targets) acrossdocs/source/,pcapkit/andtests/. Fixed 7 wrong ones: two abbreviatedpcapkit/protocols/{internet/hip,transport/tcp}.pycitations missing theirdirectory prefix in
tests/protocols/test_option_roundtrip_unit.py, andfive references in
tests/corekit/test_sentinel_exports_unit.pystillpointing at
docs/source/conventions.rst's pre-refactor(docs): move the process pages out of the docs top level #901-move location. The restare either external files, gitignored generated fixtures, deliberate
historical references, or abbreviated mentions with directory context
already established in the same file -- not defects.
Sphinx warnings: 58 on
origin/main, 61 here (+3), allduplicate object descriptionfor the three private methods explicitlyre-
automethod'd inenum.rst-- the same patterninfoclass.rstalreadyuses for
Info.__init_subclass__/__post_init__.Docs-only change (plus two comment-only
:file:fixes in existing tests, nobehaviour touched), so there is no coverage delta to claim.