Repository navigation
docs(corekit): fifth whole-repo pass over corekit, const and vendor (#1103) - #2156
Merged
Merged
Conversation
…1103) - Correct the module directives of the HIP vendor crawlers and of mn_group_id, and the class the MH status-code crawler generates. - Name can_seek in the corekit.io module docstring; describe how OptionField's option_padding reaches the packet; fix the HIP vendor page's opening and the NGAP vendor page's pointer to a docstring the page does not render. - Cite the protocols registry seeding by name, not file:line; point the pcapng and vlan request() docstrings at their own LINK; drop PR-timed context from vendor comments. - Grammar and typo fixes across corekit and vendor. Prose only: every changed .py keeps its AST once docstrings are removed.
Owner
Author
|
GOOD TO GO at
|
Contributor
|
Coverage: 91.55% (unit tier, Python 3.15,
Per-file detail: the |
Owner
Author
|
Ready to merge at
|
This was referenced Oct 25, 2026
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 change (prose only; narrow selections below)What is the purpose of your pull request?
docs— documentation onlyDescription
Part of #1103 round 5: the corekit, const and vendor slice, on
mainat4c3d30163. Prose only: the AST with docstrings stripped is identical on all 40 changed.pyfiles.pcapkit.const.hip…where they meanpcapkit.vendor.hip….mn_group_iddeclared the wrong module name, andvendor/mh/status_code.pynamed the wrong class.corekit.ionow namescan_seek.OptionField.unpack: the padding is recorded bySchema.unpackas__option_padding__.DeferredPacket.to_dictreturns whatInfo.to_dictexports.InfoMetanote now covers__included__.vendor/ngap.rstgives its reason inline rather than pointing at an unrendered docstring.request()docstrings citedLinkType.LINKinstead of their own class.fields/misc.pynow names the seeding loop instead of citing__init__.py:76.corekitandvendor. Generated const files are untouched: fixing their prose means editing the vendor template strings, which changes the AST.tests/project/test_docs_*, the conventions, docstring-contract and vendor tests: 270 passed.tests/{vendor,const}: 534 passed.tests/corekit: 681 passed.