Repository navigation
docs(vendor): fix AppType template prose and six crawler Args mismatches (#2175) - #2180
Merged
Merged
Conversation
JarryShaw
added
docs
…hes (#2175) Problem: the AppType template BASE (mirrored in the generated const module) carried change-relative and counted prose, and six crawler docstrings named the wrong parameter, held as KNOWN_DEFECTS. Fix: - Reword TransportProtocol's class comment, TransportProtocol.get (docstring and NOTE), AppType.__repr__'s NOTE and AppType.get_all in the template and, identically, in pcapkit/const/reg/apptype/apptype.py (regeneration needs IANA's live CSV): no counts, no timed wording. - mh/{binding_ack,binding_update,handover_ack,handover_initiate}_flag: context() documents 'data'; drop the useless arguments-differ / arguments-renamed pragmas on context() and process(). - pcapng/option_type.context() and vlan/priority_level.process(): document 'soup'. Test: tests/test_docstring_contract.py drops the six KNOWN_DEFECTS entries; test_documented_parameters_exist now guards all six.
JarryShaw
force-pushed
the
docs/2175-apptype-prose-known-defects
branch
from
October 25, 2026 07:38
79d15c6 to
55416da
Compare
Owner
Author
|
Review: GOOD TO GO at |
JarryShaw
added
review: good-to-go
Contributor
|
Coverage: 91.55% (unit tier, Python 3.15,
Per-file detail: the |
Owner
Author
|
Ready to merge at
|
5 tasks done
JarryShaw
removed
the
review: good-to-go
5 tasks done
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
Closes #2175.
TransportProtocolclass comment,TransportProtocol.getand its exception note,AppType.__repr__andAppType.get_all. Each is reworded or cut, keeping the claims accurate. The edits are inpcapkit/vendor/reg/apptype/apptype.pyand, with byte-identical lines, in the generatedpcapkit/const/reg/apptype/apptype.py; regeneration needs IANA's live CSV. History tied to a named issue stays.Args::mh/*_flag.pycontext()methods documentdata, notsoup, and drop the stalearguments-differ,arguments-renamedpragmas oncontext()andprocess()(pylint reports them as useless suppressions; the score is unchanged);pcapng/option_type.context()andvlan/priority_level.process()documentsoup.KNOWN_DEFECTSintests/test_docstring_contract.pyis now empty, sotest_documented_parameters_existguards all six.option_type.pyandpriority_level.pyin other hunks, and docs(tests): fifth whole-repo pass over tests (#1103) #2159 touches apptype tests. Both merge cleanly with this branch.