Skip to content

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

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103b-corekit
Oct 15, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1103b-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

Summary

#1103 second whole-repo pass, corekit slice.

  • Backfill directives, template and const alike: OptionType 1.1.0 and
    AppType 1.1.1 (int, compare, hash by code; AppType's raised
    AttributeError until 1.1.1); _Field removed 1.3.0 (field.py,
    field.rst); VersionInfo str and beholder logging 1.3.0; Info
    iteration 1.3.3.
  • Stale claims: PortEnumField's width check (_missing_ never raises
    in width), its isinstance sites, _validate_value's callers, the empty
    FieldMeta/VendorMeta, Vendor as a "meta class", and the IPX
    packet crawler, which does not crawl either.
  • Cross-references: _missing_, ProtocolError, FieldValueError,
    struct, aenum.StrEnum, the APPTYPE page links, MH_CGAExtension
    and vendor VLAN targets, and a role split across two #: lines.
  • Labels: IPv6_ExtensionHeader, HTTP_StatusCode; the vendor IPv4
    table lists TSFlag.
  • Timed wording dropped from parts of the AppType template (const
    mirrored).
  • Typos: a stray period in pcapkit.vendor, "enumerate registry" x5.

Template output matches both const modules. AST guard identical bar the
two templates, identical with every string blanked. tests/project,
const, vendor, corekit, dumpkit, foundation/registry and
test_docstring_contract pass.

Refs #1103

…1103)

- Backfill directives, template and const alike: `OptionType` 1.1.0 and
  `AppType` 1.1.1 (int, compare, hash by code; `AppType`'s raised
  `AttributeError` until 1.1.1); `_Field` removed 1.3.0 (`field.py`,
  `field.rst`); `VersionInfo` str and `beholder` logging 1.3.0; `Info`
  iteration 1.3.3.
- Stale claims: `PortEnumField`'s width check (`_missing_` never raises
  in width), its isinstance sites, `_validate_value`'s callers, the empty
  `FieldMeta`/`VendorMeta`, `Vendor` as a "meta class", and the IPX
  packet crawler, which does not crawl either.
- Cross-references: `_missing_`, `ProtocolError`, `FieldValueError`,
  `struct`, `aenum.StrEnum`, the `APPTYPE` page links, `MH_CGAExtension`
  and vendor VLAN targets, and a role split across two `#:` lines.
- Labels: `IPv6_ExtensionHeader`, `HTTP_StatusCode`; the vendor IPv4
  table lists `TSFlag`.
- Timed wording dropped from parts of the `AppType` template (const
  mirrored).
- Typos: a stray period in `pcapkit.vendor`, "enumerate registry" x5.

Template output matches both const modules. AST guard identical bar the
two templates, identical with every string blanked. tests/project,
const, vendor, corekit, dumpkit, foundation/registry and
test_docstring_contract pass.

Refs #1103
@JarryShaw JarryShaw added the docs Pull requests that change documentation only (docs: subject prefix) label Oct 15, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verdict: GOOD TO GO at a5358e12e. The first Sonnet review found four misdated backfill directives; a fix round and a Sonnet re-check, each measured over the v1.* tags, settled them:

  • the value and str format change shipped in v1.0.3.post2, outside the 1.1.0–1.4.1 backfill, so it is dropped;
  • OptionType's int/compare/hash moves to 1.1.0, as 1.1.0.rst credits it;
  • AppType's stays at 1.1.1, because in 1.1.0's .post builds those methods read an attribute AppType never set, and they first worked in 1.1.1 (e3dd2ef11).

Each const file matches its vendor template, and the AST guard passes on all changed files. tests/project and the const, vendor and corekit tests pass.

@JarryShaw JarryShaw added the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 2026
@JarryShaw
JarryShaw merged commit 20323b0 into main Oct 15, 2026
13 checks passed
@JarryShaw
JarryShaw deleted the docs/1103b-corekit branch October 15, 2026 23:55
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 2026
@JarryShaw JarryShaw moved this to Done in PyPCAPKit Oct 16, 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