Skip to content

docs(corekit): fifth whole-repo pass over corekit, const and vendor (#1103) - #2156

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103-r5-corekit
Oct 25, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1103-r5-corekit

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Part of #1103 round 5: the corekit, const and vendor slice, on main at 4c3d30163. Prose only: the AST with docstrings stripped is identical on all 40 changed .py files.

  • Wrong module directives. The HIP vendor modules declared pcapkit.const.hip… where they mean pcapkit.vendor.hip…. mn_group_id declared the wrong module name, and vendor/mh/status_code.py named the wrong class.
  • Stale claims:
    • corekit.io now names can_seek.
    • OptionField.unpack: the padding is recorded by Schema.unpack as __option_padding__.
    • DeferredPacket.to_dict returns what Info.to_dict exports.
    • The InfoMeta note now covers __included__.
    • vendor/ngap.rst gives its reason inline rather than pointing at an unrendered docstring.
    • Four request() docstrings cited LinkType.LINK instead of their own class.
  • Timed context and anchors. Dropped "an earlier round of this same PR", "this fix" and "this change". fields/misc.py now names the seeding loop instead of citing __init__.py:76.
  • Grammar and typos across corekit and vendor. Generated const files are untouched: fixing their prose means editing the vendor template strings, which changes the AST.
  • Tests:
    • tests/project/test_docs_*, the conventions, docstring-contract and vendor tests: 270 passed.
    • tests/{vendor,const}: 534 passed. tests/corekit: 681 passed.
    • isort and public API: 11 passed.

…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.
@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) review: running A cross-review is in flight against the current head - no verdict yet labels Oct 25, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

GOOD TO GO at 1e82e49fe (Sonnet review).

  • Module directives: the 19 HIP vendor directives now match their import paths. The old pcapkit.const.hip* names duplicated the const pages, so this also removes a collision. mn_group_id and the StatusCode class name are right.
  • Claims against the code:
  • Generated files: only const/__init__.py (hand-written) changed. No generated const file was touched.
  • Checks: no new counts, timed context or file:line anchors. The AST guard passes on all 41 .py files. The required tests pass (112), as do tests/{vendor,corekit} (850).
  • UNVERIFIED: how the HIP directive targets render in a pinned Sphinx build.

@JarryShaw JarryShaw added review: good-to-go Cross-review at the current head says ready; CI state is separate and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 25, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 91.55% (unit tier, Python 3.15, 1e82e49fe, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 2 95.16%
pcapkit/const 19599 880 2618 866 92.12%
pcapkit/corekit 2589 75 816 37 96.48%
pcapkit/dumpkit 282 3 102 3 98.44%
pcapkit/foundation 2971 23 1036 25 98.80%
pcapkit/interface 138 4 52 3 96.32%
pcapkit/protocols 17418 219 4574 185 98.14%
pcapkit/toolkit 869 36 298 10 95.20%
pcapkit/utilities 504 7 146 5 98.15%
pcapkit/vendor 4432 1988 1018 167 51.87%

Per-file detail: the coverage-html artifact of this run.

@JarryShaw

Copy link
Copy Markdown
Owner Author

Ready to merge at 1e82e49fe.

  • Review: Sonnet GOOD TO GO.
  • CI: all 61 CheckRuns passed, none failed or still running. Required checks passed is SUCCESS, and the KTLO legs raised no warnings.
  • Ordering: I merged this PR into main and ran tests/project plus the root modules under the plain unittest ordering leg: 2288 tests, 0 failures, 0 errors.
  • Other round-5 PRs: no conflicts.

@JarryShaw
JarryShaw merged commit 44342d8 into main Oct 25, 2026
65 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 25, 2026
@JarryShaw
JarryShaw deleted the docs/1103-r5-corekit branch October 25, 2026 14:11
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 25, 2026
@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Pull requests that change documentation only (docs: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant