Repository navigation
docs(protocols): fifth whole-repo pass over application, misc and the protocol base (#1103) - #2154
Conversation
… protocol base (#1103) - keep_short_read: the key is listed in Data.__included__, not an ordinary one (#2003) - register_frame/register_block/_option/_record/_secrets: meth is a method name or a (parser, constructor) pair, not a single callable - SHB pre_pack: the magic is not palindromic; NRB length is the Block Total Length - Frame._ghdr holds the data model; the CB padding comment names the right idiom; HTTP/2 __length_hint__ is a hint, not a total length - ngap.rst: unnamed values, not IEs; misc/index.rst grammar - document the helpers rendered text names: Schema._cut_short_read, keep_short_read, replay_short_read, _cut_last_line, _malformed_line_message Prose only; AST unchanged. tests/project docs tests and nearby protocol tests pass.
c171f9b to
e0db51b
Compare
|
GOOD TO GO at The Sonnet review of
|
|
Coverage: 91.55% (unit tier, Python 3.15,
Per-file detail: the |
|
Ready to merge at
|
make testpasses, and a test case covers the change (prose only; narrow selections below)What is the purpose of your pull request?
docs— documentation onlyDescription
This is part of #1103, round 5: the application, misc and protocol-base slice, on
mainat4c3d30163. It is prose only; the docstring-stripped AST is identical on all 5 changed.pyfiles.methargument:HTTP.register_frameand thePCAPNG.register_block/option/record/secretsmethods saidmethwas a "method name or callable". The code indexes a non-string entry[0]/[1], so it is a(parser, constructor)pair. This matches docs(protocols): fifth whole-repo pass over link and transport protocols (#1103) #2152's TCP/SCTP fix.keep_short_read:__short_read__is a metadata key inData.__included__since fix(protocols): Info field order follows PyPy's attribute layout, not the declared fields #2003.SectionHeaderBlock.pre_pack: the magic number is not palindromic.NameResolutionBlock.lengthis the Block Total Length.Frame.__post_init__:_ghdrholds the data model._make_block_cb: corrected the padding idiom it quotes.__length_hint__: corrected its description.ngap.rst: pycrate decodes "values", not "IEs"._cut_last_line,_malformed_line_message,Schema._cut_short_read,keep_short_readandreplay_short_read.tests/project/test_docs_*, the conventions and documentation-claims tests, andtests/protocols/{misc,application}plus the base tests all pass (220 + 278 + 251 + 40).