Skip to content

docs: numbers.rst has no autofunction stubs for #771's two new unregistered-member helpers #780

Description

@JarryShaw

Surfaced by #771's round-two cross-review, and it cannot land until #771 merges.

#771 adds two module-level helpers to pcapkit/corekit/fields/numbers.py — _rebuild_unregistered_member and _reduce_unregistered_member — which together implement the functools.partial-based __reduce_ex__ that keeps an unregistered enum member picklable. Both carry full Args:/Returns: docstrings, but docs/source/pcapkit/corekit/fields/numbers.rst has no stubs for them, so neither is rendered.

docs/source/pcapkit/corekit/fields/numbers.rst was outside the owned file set of the agent that wrote #771, which is why it was left — flagged by that agent rather than missed.

The repo's precedent is individual stubs, not a blanket toggle. :private-members: is commented out repo-wide, and pcapkit/foundation/engines/_pcap_backend.py's _purge — a module-level _-prefixed helper of exactly this shape — is documented with its own .. autofunction::. So the two entries wanted, under the file's existing Internal Definitions heading, are:

.. autofunction:: pcapkit.corekit.fields.numbers._rebuild_unregistered_member

.. autofunction:: pcapkit.corekit.fields.numbers._reduce_unregistered_member

#771 also refers to both helpers in double backticks rather than with :func: roles, deliberately, to avoid a dangling cross-reference while the stubs are absent. Once the stubs exist those prose references can become :func: roles — worth doing in the same change so the two do not drift.

Checkable blocker: #771 merged. The functions do not exist on main until then, so adding the stubs first would break the docs build rather than fix anything. After that this is a docs-only change and goes straight to main.

Activity

  1. added
    docsPull requests that change documentation only (docs: subject prefix)
    blockedDeferred pending another issue or decision; see the last comment for what unblocks it
    on Sep 25, 2026
  2. JarryShaw commented on Sep 25, 2026

    @JarryShaw
    OwnerAuthor

    Verified anchors, so whoever picks this up does not have to find them: the Internal Definitions heading is at docs/source/pcapkit/corekit/fields/numbers.rst:48-49, currently holding a single .. autoclass:: pcapkit.corekit.fields.numbers.NumberField at :51. The _purge precedent is real and sits at docs/source/pcapkit/foundation/engines/3rdparty.rst:481.

  3. JarryShaw commented on Sep 25, 2026

    @JarryShaw
    OwnerAuthor

    Unblocked — #771 merged at 12:15:12Z as 9012f57f8, so _rebuild_unregistered_member and _reduce_unregistered_member now exist on main (fe80b8525) and the stubs will resolve. Dispatching.

  4. 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 Sep 25, 2026
  5. added a commit that references this issue on Sep 25, 2026
  6. removed
    wipWork in flight - a covering PR is open or an agent is actively on it
    on Sep 25, 2026
  7. added this to the 1.5 milestone on Oct 6, 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