Repository navigation
docs(protocols): sixth whole-repo pass over link and transport (#1103) - #2207
Merged
Merged
Conversation
Correct the ARP bool-guard notes: without the guard a bool reaches the generic ProtocolError, not a TypeError (#2166). State the L2TPv2 total_length note timelessly; drop the count of concrete VLAN tags and fix a verb agreement.
Owner
Author
|
Review: GOOD TO GO at
|
Owner
Author
|
Ready to merge at
|
Contributor
|
Coverage: 91.56% (unit tier, Python 3.15,
Per-file detail: the |
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
Part of #1103, round 6: the sixth whole-repo prose pass, covering
pcapkit/protocols/{link,transport}/with their schema, data and API pages.ARP._make_addr_resolveandARP._make_proto_resolvesaid a bool would fail later as aTypeError. Since fix(arp): a bool or int protocol address with a non-IP ptype raises TypeError, not FieldValueError #2166 the fallback branches raiseProtocolError. Measured on this head:ARP(sha=5)andARP(ptype=0x1234, spa=5)raiseProtocolError, and the bool forms raiseFieldValueError.L2TPv2._make_dataNOTE (fix(l2tp): L2TPv2.from_data drops the L flag and the Length field #1172) is in the conditional, not the past tense.vlan.pyandvlan.rst.main.tests/project/test_docs_*plustest_conventions_doc_claims(104 passed).tests/protocols/linkplustest_docstring_contract(116 passed).