Skip to content

docs: date the __excluded__ and Raw directives to the release that shipped them (#1933) - #1934

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1933-late-directives
Oct 19, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1933-late-directives

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

Two versionchanged:: 1.3.3 directives describe changes that first shipped in 1.3.1.post8:

  • Info.__iter__ gained its __excluded__ skip in ab8a21c7a.
  • Raw became Raw(Protocol) with no packet field in a7d5df73c.

v1.3.1.post7 has neither change, and the files are unchanged from post8 through 1.3.3. Under the ruling on #1911, a post-release change is marked with its own post-release, so both directives now say 1.3.1.post8. The edits are docstring-only, and the AST is identical. docs/source/changelog/1.3.3.rst still lists both changes under 1.3.3; changelog edits stay with #657.

Closes #1933

…ipped them (#1933)

- Info: iteration skipping __excluded__ names first shipped in
  1.3.1.post8, not 1.3.3.
- data.misc.raw.Raw: packet left Raw's fields, and the constructor's
  signature, in 1.3.1.post8, when the base Protocol data class took it
  over, not in 1.3.3.

Docstrings only; the AST is identical with docstrings blanked.

Closes #1933
@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

Copy link
Copy Markdown
Owner Author

GOOD TO GO at 009f5b8df. A Sonnet cross-review scanned v1.3.1, every post-release to post28, and v1.3.3. In each tag up to post7, Info.__iter__ yields every key, and Raw(Data) takes packet both as a field and as a constructor argument. From post8 on, __iter__ skips __excluded__ and Raw(Protocol) has only protocol and error. Every post tag's name matches its __version__, and 1.3.1.post8 is on PyPI with wheels. Both files are AST-identical to main once docstrings are blanked. The 1.3.3 changelog page groups these changes under 1.3.3, which is a separate question for the historical changelog.

@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
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 19, 2026
@JarryShaw
JarryShaw merged commit 53c2a36 into main Oct 19, 2026
54 checks passed
@JarryShaw
JarryShaw deleted the docs/1933-late-directives branch October 19, 2026 15:02
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 19, 2026
@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.

docs: two versionchanged:: 1.3.3 directives describe behaviour that shipped long before 1.3.3

1 participant