Skip to content

docs(protocols): second whole-repo pass over application, misc and the protocol base (#1103) - #1800

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

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

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

Version directives, 1.1.0-1.4.1 backfill:

  • Protocol: versionchanged 1.3.0. The built-in families moved onto
    ProtocolBase, so a built-in protocol is not an instance of Protocol,
    and a Protocol subclass registers itself in pcapkit.protocols.proto.
  • data.misc.raw.Raw: versionchanged 1.3.3. packet left its fields when the
    base data class took it over, so the constructor takes protocol and
    error only.

Accuracy:

  • ProtocolBase.unpack: since fix(protocols): ProtocolBase.pack() without keywords replaces the instance's header #1769, pack() sets header only on the
    call post_init makes during construction, so the note names that
    call and from_schema() rather than pack() in general.
  • HTTP.make: Returns said bytes; it returns the versioned make()'s schema.
  • pcapkit.protocols.proto: the values are ProtocolBase subclasses,
    and the built-in ones are not Protocol subclasses.

AST guard identical on all four files; tests/project and the pack, HTTP
and docstring-contract tests pass.

Refs #1103

…e protocol base (#1103)

Version directives, 1.1.0-1.4.1 backfill:
- Protocol: versionchanged 1.3.0. The built-in families moved onto
  ProtocolBase, so a built-in protocol is not an instance of Protocol,
  and a Protocol subclass registers itself in pcapkit.protocols.__proto__.
- data.misc.raw.Raw: versionchanged 1.3.3. packet left its fields when the
  base data class took it over, so the constructor takes protocol and
  error only.

Accuracy:
- ProtocolBase.unpack: since #1769, pack() sets __header__ only on the
  call __post_init__ makes during construction, so the note names that
  call and from_schema() rather than pack() in general.
- HTTP.make: Returns said bytes; it returns the versioned make()'s schema.
- pcapkit.protocols.__proto__: the values are ProtocolBase subclasses,
  and the built-in ones are not Protocol subclasses.

AST guard identical on all four files; tests/project and the pack, HTTP
and docstring-contract tests 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 ec2afbc80. 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, 3 warnings, 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 c49e4e3 into main Oct 15, 2026
13 checks passed
@JarryShaw
JarryShaw deleted the docs/1103b-application 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