Repository navigation
docs(protocols): second-round pass over the application-layer prose (#719) - #1082
Merged
Merged
Conversation
…719) Correct claims the code contradicts: the OSPF header table's octet and bit offsets, the 'contains X only' module summaries in ftp, rarp and ngap, the HTTP._guess_version Raises section, the httpv1 obs-fold rationale, the httpv2 __frame__ mapping, and two mislabelled section comments in the package __init__. Drop leftover timed context in ospf and httpv1, and document the missing make-helper arguments in httpv2.
Contributor
|
Coverage: 88.74% (unit tier, Python 3.14,
Per-file detail: the |
Owner
Author
|
Cross-review verdict on
UNVERIFIED: the full Sphinx build was not run (docutils parse only, no new messages), and 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.
Please follow the guide below
make testpasses, and a test case covers the change — docstrings and comments only; per-module runs belowWhat is the purpose of your pull request?
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingchore— anything elseDescription of your pull request and other information
Second-round #719 read of
pcapkit/protocols/application/. Fixes only where the code contradicts the prose:ospf.py: header table offsets were wrong (type at octet 0, auth at octet 1); now 0/1/2/4/8/12/14/16, matching the schema. Dropped "as this did" history from the-1dispatch comment.http.py:_guess_version'sRaises:claimed any non-ProtocolErrorfailure falls through. A mock probe shows it escapes from both HTTP/1 arms, and only the final HTTP/2 trial absorbsstruct.error.httpv1.py: the obs-fold comment said a colon-less continuation raisesIndexError, but the colon check below raisesProtocolError. Two past-tense lines made conditional.httpv2.py:__frame__comment now describes the str /(parser, constructor)lookup and the_nonefallback. Added the missingpad_len/error_*args.ftp.py,rarp.py,ngap.py: "contains X only" omittedFTP_DATA,DRARPand the NGAP enums.ftp.pygets a proper title.__init__.py,application.py: mislabelled section comments, a wrongNoPayloadpath, "eg. … and etc."Sphinx
-non fresh output: 12 warnings for these files on both branch andmain, none new. Tests: everytests/protocols/application/test_*.py,test_tcp_http_dispatch_unit.py,tests/project,tests/test_docstring_contract.py, one module per process, all pass.origin/main)__init__.pyapplication.pyftp.pyhttp.pyhttpv1.pyhttpv2.pyngap.pyospf.pyrarp.py