Skip to content

docs(foundation): second whole-repo pass over foundation (#1103) - #1801

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

JarryShaw merged 1 commit into
mainfrom
docs/1103b-foundation

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, foundation slice.

Directives, 1.1.0-1.4.1 backfill (18, in 7 files):

  • Extractor.reassembly/.trace raise UnsupportedCall when off (1.1.1);
    Extractor and extract() rename strict to reasm_strict (1.2.0).
  • TraceFlow.register renamed register_dumper (1.2.0); register_port
    renamed register_apptype (1.3.1), both versionremoved.
  • Engine, Reassembly, TraceFlow: metaclass-supplied name/protocol and
    registration at class definition (1.3.0).
  • The Extractor and TraceFlowBase register_* methods take a descriptor
    or class; register_extractor_engine's engine is name; ext is
    keyword-only on the three dumper registrars (1.3.0).

Accuracy:

Rendered markup:

  • Three utilities.config doc-comments split a role across their first
    line, which napoleon's NumPy pass ate; reflowed.

AST guard identical on all nine files; tests/project and the pinning
selections pass.

Refs #1103

Directives, 1.1.0-1.4.1 backfill (18, in 7 files):
- Extractor.reassembly/.trace raise UnsupportedCall when off (1.1.1);
  Extractor and extract() rename strict to reasm_strict (1.2.0).
- TraceFlow.register renamed register_dumper (1.2.0); register_port
  renamed register_apptype (1.3.1), both versionremoved.
- Engine, Reassembly, TraceFlow: metaclass-supplied name/protocol and
  registration at class definition (1.3.0).
- The Extractor and TraceFlowBase register_* methods take a descriptor
  or class; register_extractor_engine's engine is name; ext is
  keyword-only on the three dumper registrars (1.3.0).

Accuracy:
- IPv6._rectify_header names the four adapters that build IPv6 data.
- register_protocol states what #514 did with the name key.

Rendered markup:
- Three utilities.config doc-comments split a role across their first
  line, which napoleon's NumPy pass ate; reflowed.

AST guard identical on all nine files; tests/project and the pinning
selections 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 0ca7713c0. A Sonnet cross-review (author: Opus) found no blocking findings. Scope stays inside the slice, the AST guard is identical against main, and every directive was checked against the release tags. The merged build of all nine second-pass heads has 18 warnings, the same as main. tests/project: 950 passed, 1 skipped, 3670 subtests passed..

@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 44c3961 into main Oct 15, 2026
13 checks passed
@JarryShaw
JarryShaw deleted the docs/1103b-foundation branch October 15, 2026 23:40
@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