Repository navigation
docs(protocols): second-round pass over the data-model prose (#719) - #1080
Merged
Merged
Conversation
- Fix "preserved keyword" to "reserved keyword" in the IPv4/IPv6 from_dict notes and comments. - Drop timed context from SOLUTION's reserved-octet note; keep why it is not a Lifetime. - Correct NoPayload's comment on what Info generates for a class with no annotations, and IPv6_Ext.protocol's None condition. - Document IPv4 options and TR originator, and repair IPDFFOption's flags doc comment in HOPOPT and IPv6-Opts. - Name both VLAN tag types in the package-index comments. - Fix typos (crytographic, moddel, modelf, compability, Publick, Sendder, ZigBEE). Comments and docstrings only; AST guard identical for all 14 files.
Contributor
|
Coverage: 88.74% (unit tier, Python 3.14,
Per-file detail: the |
Owner
Author
|
Cross-review verdict on
|
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 change — full suite not run; affected modules run one per process, all passWhat is the purpose of your pull request?
docs— documentation onlyDescription
Round-two re-read of every file under
pcapkit/protocols/data/for #719 (38 files read, 14 changed). Comments and docstrings only.preserved keyword→reserved keyword(IPv4ToSField/TROption,IPv6).SolutionParameter.reserved: replaced the "used to be read as a Lifetime" history with the standing reason (onlyPUZZLEhas a Lifetime;0x00would not re-serialise, per_make_puzzle_lifetime).NoPayloadcomment:Infogenerates__init__(self, dict_=None, **kwargs)for an annotation-less class (probed), rather than "skipping" it.IPv6_Ext.protocol:Nonealso whenaliasis not given (readonly resolves a non-Nonealias).IPv4.options(set only whenhdr_len > 20) andTROption.originator; fixed#:Flags./# :Flags.onIPDFFOption.flags(the latter was not a doc comment at all).vlan.py.Sphinx
-n, fresh dirs: 46 warnings mention this slice on both main and branch, none new. Tests (one module per process) andtests/projectpass.AST guard (every bare-string
Exprstripped),origin/mainvs branch:pcapkit/protocols/data/__init__.pypcapkit/protocols/data/application/httpv2.pypcapkit/protocols/data/application/ospf.pypcapkit/protocols/data/internet/hip.pypcapkit/protocols/data/internet/hopopt.pypcapkit/protocols/data/internet/ipv4.pypcapkit/protocols/data/internet/ipv6.pypcapkit/protocols/data/internet/ipv6_ext.pypcapkit/protocols/data/internet/ipv6_opts.pypcapkit/protocols/data/internet/mh.pypcapkit/protocols/data/link/__init__.pypcapkit/protocols/data/misc/null.pypcapkit/protocols/data/misc/pcapng.pypcapkit/protocols/data/transport/tcp.py