Skip to content

docs(vendor): the AppType template keeps a release-versioned note and decision history #2315

Closed

Description

@JarryShaw

Is your feature request related to a problem? Please describe.
Two passes of BASE in pcapkit/vendor/reg/apptype/apptype.py read as history. Both are mirrored in the generated pcapkit/const/reg/apptype/apptype.py.

  • The comment on TransportProtocol says: "Before 1.5.0 the class was an IntFlag with sctp at 4 and dccp at 8 …".
  • TransportProtocol.get says: "… rather than from any name-miss policy. So there was no policy here to preserve".

#1872 ruled that the vendor templates and the generated files carry no version directives, and that a user-facing change note goes on the hand-written docs/source/pcapkit/const/*.rst page. The .. versionchanged:: 1.5.0 on docs/source/pcapkit/const/reg.rst already records the renumbering, so the template comment duplicates it in prose.

Describe the solution you'd like
Drop the "Before 1.5.0 …" sentence from the template comment, and add the bare-4-resolves-as-dccp hazard to the reg.rst note if it is wanted. Restate the get passage as current behaviour: a name miss raises EnumKeyError from the base. Change the template and the const file together, without re-crawling.

Describe alternatives you've considered
Keep the release-versioned note as a deliberate exception to #1872.

Additional context
#2175 reworded the change-relative prose in the same template and left these two passes.

Recommendation: move the note to the docs and restate get, as #1872 ruled.

Activity

  1. added this to the PyPCAPKit v1.5 milestone on Oct 26, 2026
  2. added
    docsPull requests that change documentation only (docs: subject prefix)
    designA design or decision issue: a pattern being decided rather than a defect or a request
    constRegenerated IANA or vendor constant tables; members keep their numeric values
    needs: decisionWaiting on the maintainer to decide — not blocked by other work
    on Oct 26, 2026
  3. moved this to Needs decision in PyPCAPKiton Oct 26, 2026
  4. JarryShaw commented on Oct 26, 2026

    @JarryShaw
    OwnerAuthor

    take recommendations

  5. JarryShaw commented on Oct 26, 2026

    @JarryShaw
    OwnerAuthor

    Ruling noted: taking the recommendation. A fix worker is on it; the PR will reference this issue.

  6. added
    wipWork in flight - a covering PR is open or an agent is actively on it
    and removed
    needs: decisionWaiting on the maintainer to decide — not blocked by other work
    on Oct 26, 2026
  7. moved this from Needs decision to WIP in PyPCAPKiton Oct 26, 2026
  8. removed
    wipWork in flight - a covering PR is open or an agent is actively on it
    on Oct 28, 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 valuesdesignA design or decision issue: a pattern being decided rather than a defect or a requestdocsPull requests that change documentation only (docs: subject prefix)

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions