Skip to content

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

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103d-corekit
Oct 19, 2026
Merged

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

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

Please follow the guide below

What is the purpose of your pull request?

Tick the commit type your subject line carries.

  • fix — corrects a defect
  • feat — adds a feature
  • perf — changes performance, not behaviour
  • refactor — changes neither behaviour nor performance
  • test — tests only
  • docs — documentation only
  • ci — workflows or build tooling
  • release — bumps the version or rolls up a distribution
  • chore — anything else

The fourth whole-repo prose pass of #1103, over corekit, const and vendor. It changes prose only: every changed .py file's AST is unchanged once string expressions are blanked, except where a docstring is added or vendor template text is edited together with its generated const file.

Cross-references:

  • point the get overrides hidden by :meta private: (Method, AppType)
    at literal names or the class, so the rendered text keeps the class
  • link the per-transport AppType registries by full path in the
    register_alias template and its generated docstring
  • use the roles and modules the Python inventory carries: sys.version_info
    is data, SEEK_* live in os, str is a class
  • point vendor request() docstrings at their own module's DATA

Accuracy:

  • TS flag registry cites RFC 791, not RFC 719
  • L2TP Type's request() describes L2TP packet types, not TCP checksums
  • drop a stray full stop in an LLA option code description

Counts and wording:

  • word vendor comments on IPX, EtherType and AppType without counts
  • "cf." for "c.f.", "a collection of", "work like", "modelled on"

Refs #1103

…1103)

Cross-references:
- point the `get` overrides hidden by `:meta private:` (Method, AppType)
  at literal names or the class, so the rendered text keeps the class
- link the per-transport AppType registries by full path in the
  register_alias template and its generated docstring
- use the roles and modules the Python inventory carries: sys.version_info
  is data, SEEK_* live in os, str is a class
- point vendor `request()` docstrings at their own module's DATA

Accuracy:
- TS flag registry cites RFC 791, not RFC 719
- L2TP Type's request() describes L2TP packet types, not TCP checksums
- drop a stray full stop in an LLA option code description

Counts and wording:
- word vendor comments on IPX, EtherType and AppType without counts
- "cf." for "c.f.", "a collection of", "work like", "modelled on"

Refs #1103
@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 19, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 19, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

GOOD TO GO at 335c80597. A Sonnet cross-review found no blocking problems. The _EnumRegistry.__missing__ docstring is the only non-prose AST change, and it was expected. Two optional notes are left as they are: "all three services on TCP/80" in the apptype template is an IANA registry fact, and the retargeted vendor DATA refs were unresolved before as well.

@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 19, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 90.07% (unit tier, Python 3.15, 335c80597, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 2 20 2 96.77%
pcapkit/const 19595 881 2618 867 92.11%
pcapkit/corekit 2504 70 792 36 96.54%
pcapkit/dumpkit 276 3 100 3 98.40%
pcapkit/foundation 2916 164 1016 34 93.59%
pcapkit/interface 138 7 52 5 93.68%
pcapkit/protocols 17411 224 4580 189 98.10%
pcapkit/toolkit 872 177 298 8 77.18%
pcapkit/utilities 522 2 158 4 99.12%
pcapkit/vendor 4431 2341 1018 156 43.64%

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

@JarryShaw
JarryShaw merged commit c716b64 into main Oct 19, 2026
58 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 19, 2026
@JarryShaw
JarryShaw deleted the docs/1103d-corekit branch October 19, 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 19, 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