Skip to content

docs: memberless enums render the functional-API call signature #1862

Closed

Description

@JarryShaw

AppType (const/reg.html), FilterType (const/pcapng.html) and FrameType.Flags (application/httpv2.html) render as (new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None).

Each has no members:

  • AppType by design, as the transport-agnostic base;
  • FilterType because the pcapng draft leaves the if_filter codes undefined;
  • FrameType.Flags as the base for per-frame flags.

For a memberless enum, the stdlib __signature__ is the functional-API form (checked on 3.14 and 3.15). Enums with members render (*values).

Fix: an autodoc-process-signature handler in conf.py that gives every enum class (*values). Verified to fix all three.

Activity

  1. added
    docsPull requests that change documentation only (docs: subject prefix)
    pendingAccepted and unstarted - nobody is on it and nothing blocks it
    on Oct 16, 2026
  2. JarryShaw commented on Oct 16, 2026

    @JarryShaw
    OwnerAuthor

    Blocked until #1856 merges. That PR bumps sphinx-autodoc-typehints, which changes how signatures render, and it edits docs/source/conf.py, which this fix also edits.

  3. added
    blockedDeferred pending another issue or decision; see the last comment for what unblocks it
    and removed
    pendingAccepted and unstarted - nobody is on it and nothing blocks it
    on Oct 16, 2026
  4. moved this to Blocked in PyPCAPKiton Oct 16, 2026
  5. JarryShaw commented on Oct 17, 2026

    @JarryShaw
    OwnerAuthor

    Started on top of #1877, the PR for #1856, so the conf.py edits don't conflict. One worker is taking #1858–#1863 together, since every fix goes through conf.py.

  6. added
    wipWork in flight - a covering PR is open or an agent is actively on it
    and removed
    blockedDeferred pending another issue or decision; see the last comment for what unblocks it
    on Oct 17, 2026
  7. moved this from Blocked to WIP in PyPCAPKiton Oct 17, 2026
  8. removed
    wipWork in flight - a covering PR is open or an agent is actively on it
    on Oct 17, 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