Skip to content

docs(api): context, IPX._next_exthdr_depth and pcapng schema helpers have no directive #2234

Closed

Description

@JarryShaw

Is your feature request related to a problem? Please describe.
Members with their own docstrings render nowhere in the API docs:

Describe the solution you'd like
Add .. autoproperty:: context to the Protocol autoclass and context to the ProtocolBase py:property group. Add .. automethod:: _next_exthdr_depth to the IPX autoclass. In pcapng.rst, add autofunction:: ...held_body, autoclass:: ...FlagsField (:members:, :show-inheritance:) and autodata:: ...PACKET_FLAGS (:no-value:). Then link the bare ``context`` in the PCAPNG versionchanged to :attr:.

Describe alternatives you've considered
Leaving _next_exthdr_depth out as a private name. That goes against the house rule: an override of a documented must-implement hook stays documented.

Additional context
Checked against origin/main 91147a1. _held_octets and _secrets_cut in the same module are also undocumented; they are private helpers, so whether they get entries is a separate call.

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 26, 2026
  2. added this to the PyPCAPKit v1.5 milestone on Oct 26, 2026
  3. removed
    wipWork in flight - a covering PR is open or an agent is actively on it
    on Oct 26, 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

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions