Repository navigation
docs(pcapkit): give every undocumented shipped module a page - #2584
Merged
Merged
Conversation
- Add const/linux.rst, vendor/tls.rst and vendor/sslv2.rst, mirroring vendor/linux.rst, const/tls.rst and const/sslv2.rst, and list them in the const and vendor toctrees. - Retitle misc/checksum.rst "Checksums" and declare the three checksum packages under it, as pcap.rst does for the pcap packages; the IP pseudo-header and Internet checksum become its sections. - const/tls.rst: both enumerations are generated by the TLS crawlers, no longer hand-curated. - Add test_docs_module_pages_2559_unit.py, pinning documentation.rst's rule that every module outside NotImplemented/ has a directive, and cite it there. Docs tests and a nitpicky partial build of the touched pages pass.
- linux_sll.rst's "Hardware Types" autoclass rendered pcapkit.const.linux.arphrd.ARPHRD a second time now that const/linux.rst documents it, so a serial nitpicky build reported duplicate object descriptions. The section now points to the const page, the single home every other const registry has. Docs tests pass; a serial nitpicky build has no duplicate warnings.
JarryShaw
added
docs
Owner
Author
|
GOOD TO GO at
|
JarryShaw
removed
the
review: good-to-go
5 tasks done
JarryShaw
added a commit
that referenced
this pull request
Nov 1, 2026
…ons into 1.6.0 (#2449) - Breaking: HTTP dispatches to HTTPv1/HTTPv2 on read, make and from_data, and so does a transport payload, whose data key moves from http to httpv1/httpv2; the members and their schema and data classes are renamed from httpv1.HTTP/httpv2.HTTP with no re-export; id() takes the RFC names; unrecognised transport payloads are Raw with no error (#2544). - Changed: conventions record the dispatching base (#2544) and the case-fold exceptions (#2583); a project test guards every shipped module's documentation entry (#2584). Summary names the HTTP change. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.
This was referenced Nov 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
This PR gives a documentation page to each shipped module that had none:
pcapkit.const.linux, and thepcapkit.vendor.tlsandpcapkit.vendor.sslv2crawlers, among others.test_docs_module_pages_2559_unitfails on any undocumented module.linux_sll.rst's "Hardware Types" now points to the const page instead of repeating
ARPHRD's autoclass, soARPHRDis documented once. A serial nitpicky build shows the 9 duplicate-object warnings gone. Againstmainit adds no warnings and clears 5 unresolved targets, and everyARPHRDlink resolves to the const page.Closes #2559