Repository navigation
docs(protocols): sixth whole-repo pass over application, misc and the protocol base (#1103) - #2210
Merged
Merged
Conversation
Owner
Author
|
Review: NEEDS CHANGES at
|
Fix stale or false prose in the application, misc and protocol-base slice: the PCAP-NG section context wording after the section_context rename, the Raw error type, the register RegistryError class, and the make() kwargs claim; restate change-relative and timed comments as timeless behaviour. Prose only; AST guard clean.
JarryShaw
force-pushed
the
docs/1103-r6-appmisc
branch
from
October 25, 2026 22:01
0792625 to
e392649
Compare
Owner
Author
|
Review: GOOD TO GO at
|
Contributor
|
Coverage: 91.56% (unit tier, Python 3.15,
Per-file detail: the |
Owner
Author
|
Ready to merge at
|
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/{application,misc}/,protocol.py, and the schema, data and API pages outside internet, link and transport.section_context(refactor(pcapng)!: rename PCAPNG.context to section_context (#2172) #2205): theRaisestext names when the block holds no section context:ctx=None, or a Section Header Block read outside the PCAP-NG engine. The engine assigns every SHB it reads the section it opens. The_ctxcomments say "section context", not "context manager".PCAPNG.registerandFrame.registercheck againstProtocolBase, notProtocol.Raw.erroris a message string, as every caller passes.HTTP.makeis named as the onemakethat reads**kwargs.secrets_areadefect is in the conditional. "As before" is gone from the__value__and__truncated_raw__notes. TheHTTP._guess_versionhistory is stated as behaviour. "Not yet known" becomes "not known".main.tests/project/test_docs_*plustest_conventions_doc_claims(104 passed).tests/protocols/{misc,application}plus the tier guard and docstring contract (667 passed).