Repository navigation
docs(protocols): tighten the schema prose and cut timed context (#719) - #1040
Conversation
- schema.py: drop issue/PR history from the registrar, finaliser and
packing notes; keep the rationale for each guard. State that
EnumSchema.registry answers on an instance and EnumMeta.registry on
the class.
- transport/tcp.py: rewrite the DSS Data ACK/DSN selector notes around
the SwitchField-versus-ConditionalField reason that still holds; cut
the PortEnumField, MPTCP FastClose and MP_CAPABLE change narratives.
- internet/{ipv4,ipv6_route,ipv6_opts,hopopt,hip,mh}.py and
misc/{pcapng,pcap/frame}.py: cut "used to"/"until #NNN" prose and
measured-before-the-fix figures; HIP padding, Quick-Start lengths and
MPTCP widths re-checked against the declared fields.
- application/httpv2.py: fix the HEADERS Flags docstring, which named
DATA frames.
- misc/pcapng.py: fix the "improt" typo in the Option example.
Docstrings and comments only; AST identical to main once docstrings are
stripped. Sphinx -n warnings for these files unchanged.
|
Cross-review verdict on
IPv4 Stream ID cut is correct, and my own earlier note was stale. Arithmetic matches the declared fields: MPTCP Fastclose 12 octets; MP_CAPABLE 12 and 20; HIP Found along the way, filed as #1042: a pre-existing defect where three of the five RFC 8684 MP_CAPABLE lengths fail to parse. It is outside this PR's scope. |
make pylint,make mypy,make isort)make testpasses, and a test case covers the changedocs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible — N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
Slice of #719 covering
pcapkit/protocols/schema/: 13 files, docstrings and comments only (+422 / -658). Cuts "used to" / "until #NNN" / measured-before-the-fix prose, keeps the rationale behind each guard, fixes a HEADERS flags docstring that named DATA frames, and aimprottypo.Not touched (nothing to cut found):
link/*,application/{ftp,httpv1,ngap,ospf,__init__},internet/{ah,esp,ipx,ipv6,ipv6_ext,ipv6_frag,__init__},misc/{__init__,null,raw},misc/pcap/{header,__init__},transport/__init__.mh.py,hip.py,pcapng.pywere only partly rewritten (timed context and issue citations); their remaining RFC prose is unchanged.Checks:
sphinx-build -b dummy -nfresh dirs, branch vs main, schema-file warnings 51 vs 51, none new.tests/project,tests/test_docstring_contract.py, the threetests/protocols/schema/modules andtest_option_roundtrip_unit.pypass, one module per process.AST guard (docstrings stripped, vs
origin/main): all 13 filesTrue.