Skip to content

docs(corekit): second pass over corekit, const and vendor (#1103) - #1786

Merged
JarryShaw merged 2 commits into
mainfrom
docs/1103-corekit-r2
Oct 15, 2026
Merged

JarryShaw merged 2 commits into
mainfrom
docs/1103-corekit-r2

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 round 2: the files phase 1 left unread, plus the phase-1 reviewers' follow-ups.

tests/project and 51 referencing test files pass. AST guard: identical
bar 5 templates; with all strings blanked only vendor/default.py differs.

Refs #1103

- Version directives: `versionchanged` on `ModuleDescriptor.klass`
  (#832), `TransportProtocol` (#808, #860, #923), `AppType` (#732, #758,
  #860) and `Method.get` (#908); `Command`'s timed note becomes one
  (#860), and `Method`'s gains #870 and #908. Template and generated
  module change alike.
- Stale claims: `AppType.get` does not mint (`numbers.py`),
  `Vendor._dest_path` handles any depth, `ForwardMatchField.__call__`
  names its own class, and `field.py`/`field.rst` cite issue #911.
- Timed wording rewritten in the `Method`, `Command`, `OptionType` and
  `AppType` templates (const mirrored), the IPX crawlers,
  `vendor/__main__.py`, `default.py`, `enum.py` and `fields/misc.py`.
- Render: `Info.__new__`'s `Note:` moves above `Args:`, as on
  `Schema.__new__`; `LINE` strips inline literals inside `**{name}**`,
  fixing `const/ipv6/smf_dpd_mode.py`.

tests/project and 51 referencing test files pass. AST guard: identical
bar 5 templates; with all strings blanked only `vendor/default.py` differs.

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 391a3e992. Sonnet review and re-check (author: Opus). The first review blocked: the Method.get directive said 1.4 returned a member. It now says 1.4.1 raised TypeError, re-measured on v1.4.1.post2, in both the template and the const file. The AST guard is identical against the base, tests/project passes, and every added directive says 1.5.0.

@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 1fd97c2 into main Oct 15, 2026
8 checks passed
@JarryShaw
JarryShaw deleted the docs/1103-corekit-r2 branch October 15, 2026 18:53
@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 15, 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