Repository navigation
docs(protocols): second-round pass over the schema prose (#719) - #1083
Merged
Merged
Conversation
- schema: EnumMeta documents EnumSchema, not SchemaMeta; fix the "enumetaion" typos; repair two cross-references split across lines - null, ethernet, hip, pcapng: describe the code as it is now rather than past revisions or behaviour - mh: Pad1 comment says length 0, as the code sets; list RFC 7028's IGMP protocol values beside the MLD ones; stop four attribute comments rendering their lead phrase as a type - ipv4, httpv2, pcapng, tcp: typos and one-word accuracy fixes - __init__: mark OSPF as application layer in the link-layer group Docstrings and comments only; AST identical to main once stripped.
Contributor
|
Coverage: 88.74% (unit tier, Python 3.14,
Per-file detail: the |
Owner
Author
|
Cross-review verdict on
Non-blocking: the OSPF comment is true but sits under the UNVERIFIED: the rendered HTML (checked with the dummy builder only), and there is no base-tree Sphinx diff. |
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 testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription
Round-two read of all 37 files under
pcapkit/protocols/schema/for #719; 10 changed, 27 left alone. Fixes: claims the code contradicts (EnumMetanaming the wrong class, MH's Pad1 comment saying length 1 while the code sets 0,NoPayload's__init__rationale, "special-case by name" vs.isinstance), past-tense history inethernet/hip/pcapng, the IGMP values RFC 7028 §8 gives alongside the MLD ones, two cross-references split across lines, four MH/PCAP-NG attribute comments whose lead phrase rendered as a type, and typos.Sphinx
-n, fresh builds: warnings naming these files drop from 50 to 40 (main → branch), none new.test_docstring_contract.py,tests/project,test_final_enforcement.pyandtests/protocols/schema/*pass.AST guard (docstrings stripped, compared with
origin/main):__init__.pyapplication/httpv2.pyinternet/hip.pyinternet/ipv4.pyinternet/mh.pylink/ethernet.pymisc/null.pymisc/pcapng.pyschema.pytransport/tcp.py