Skip to content

docs(const): link the remaining internal references in the AppType and OptionType templates #1947

Closed

Description

@JarryShaw

#1946 converts internal literals to roles everywhere except the AppType and OptionType templates and their generated const modules, which #1945 owns. These are left:

  • TransportProtocol written as a literal: pcapkit/vendor/reg/apptype/apptype.py:476 and :1106, and pcapkit/const/reg/apptype/apptype.py:2522.
  • AppType.get() written as a literal: pcapkit/vendor/reg/apptype/apptype.py:1006 and the generated pcapkit/const/reg/apptype/{tcp,udp,sctp,dccp}.py.
  • AppType.__new__, __repr__, __str__, __int__, __eq__ and OptionType.__new__ have no docstrings. docs: link library-internal references and document the missing public classes (#1940) #1946 adds their entries on reg.rst and pcapng.rst, so they render empty until docstrings are written.

Each change goes in the vendor template, and the const modules are regenerated byte-identically.

Blocked until #1945 and #1946 both merge, because both edit these files.

Activity

  1. added
    docsPull requests that change documentation only (docs: subject prefix)
    constRegenerated IANA or vendor constant tables; members keep their numeric values
    blockedDeferred pending another issue or decision; see the last comment for what unblocks it
    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 19, 2026
  2. removed
    wipWork in flight - a covering PR is open or an agent is actively on it
    on Oct 19, 2026
  3. added this to the PyPCAPKit v1.5 milestone 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

    constRegenerated IANA or vendor constant tables; members keep their numeric valuesdocsPull requests that change documentation only (docs: subject prefix)

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions