Skip to content

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

Closed

Description

@JarryShaw

Two directives name a release later than the one that shipped the behaviour they describe:

  • pcapkit/corekit/infoclass.py:320, versionchanged:: 1.3.3: iterating an instance skips __excluded__.
  • pcapkit/protocols/data/misc/raw.py:19, versionchanged:: 1.3.3: the Raw constructor takes protocol and error only.

A probe during #1911's directive audit found the first behaviour present continuously since v1.0.0b1, and the second since v0.16.2. Both are identical in v1.3.1.post28 and v1.3.3. The directives came in with #1808 (20323b042) and #1800 (c49e4e3bb). This is an inference from tag contents, so check it against git show <tag>:<path> before editing.

The fix is to date each directive to the release that first shipped the change, as ruled on #1911: a post-release change is marked with its own post-release or the next release, never the parent. If the behaviour predates any directive-worthy change, drop the directive.

Found in #1911's round-3 directive audit.

Activity

  1. added
    docsPull requests that change documentation only (docs: subject prefix)
    pendingAccepted and unstarted - nobody is on it and nothing blocks it
    wipWork in flight - a covering PR is open or an agent is actively on it
    and removed
    pendingAccepted and unstarted - nobody is on it and nothing blocks it
    on Oct 19, 2026
  2. removed
    wipWork in flight - a covering PR is open or an agent is actively on it
    on Oct 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsPull requests that change documentation only (docs: subject prefix)

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions