Skip to content

docs(conventions): record registry-protocol.rst's case-fold exceptions and the get/constructor split - #2583

Merged
JarryShaw merged 5 commits into
mainfrom
docs/2551-registry-protocol-exceptions
Nov 1, 2026
Merged

JarryShaw merged 5 commits into
mainfrom
docs/2551-registry-protocol-exceptions

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description of your pull request and other information

registry-protocol.rst records the exceptions to its case-fold rules: AppType's and HandshakeType's crawlers lower-case IANA names and Unassigned rows, ContentType, the ToS registries and SeedID fold out of turn, and Command.get and Method.get delegate keys rather than folding them. Registration Wrappers names every register override.

EnumRegistry lists _make_reducible, the #923 test drops its "mint" wording, and Method._missing_'s docstring is regenerated through the vendor template, so it changes the docstring only.

Closes #2551
Closes #2552
Closes #2553
Closes #2556
Closes #2565
Closes #2582

…ethod get/constructor split (#2551, #2552, #2553, #2556, #2565)

- registry-protocol.rst records the AppType crawler's service-name
  lower-casing as an exception, on RFC 6335 section 5.1 (#2551).
- It records Method's constructor fold and the get/constructor split on
  the #2552 ruling, not an RFC, and drops the stale "to mint" wording;
  Method._missing_'s docstring cites #2552 instead of #896 (#2552).
- It states Command.get and Method.get's name-miss, default and
  non-str-key behaviours as ruled exceptions, says what default means
  there, and removes the closing note's contradiction (#2553).
- It records the folds outside a registry get with their basis, cites
  RFC 6335 in TransportProtocol.get's docstring, corrects the str
  validator sentence and adds _make_reducible to the tier table (#2556).
- It records the ContentType, ToS and SeedID re-casings with their
  basis (#2565).

Method's const module regenerated from its crawler (docstring-only
diff); the AppType base module edited by hand to match its template.
…3 test's "mint" wording (#2552, #2556)

- EnumRegistry's class docstring lists _make_reducible among the methods
  the open tier adds, matching registry-protocol.rst's tier table (#2556).
- test_enum_get_exception_provenance_923_unit: Method.get's name miss
  returns an unregistered member that mints nothing, not a mint (#2552).
  MethodStillMintsTests is MethodUnregisteredMemberMintsNothingTests, and
  its test and the quiet-override test are renamed to match.
… as an exception (#2582)

- registry-protocol.rst records that HandshakeType's crawler lower-cases
  IANA's single-row Unassigned entries to unassigned_7 and unassigned_255,
  alongside ContentType's re-casing. No member is renamed (#2582).
…ers (#2511)

- Part 1 of Registration Wrappers names SCTP, LinuxSLL, FRAD and Netlink
  beside IPX and Loopback as overriding their parent's register, with the
  keys each map takes: PPID, ARPHRD type, NLPID and nlmsg_type.
…2552, #2553)

- "A fold can rest on a ruling" replaces an implicit count, and the
  non-str-key exception states Command.get's delegation and cites #1824
  rather than narrating it.
- The declared-but-unassigned str paragraph names Command.get and
  Method.get as the exceptions that return an unregistered member there.
- The page and Method._missing_'s docstring say the constructor's value
  match came from the fix for #2284; the const module was re-rendered
  offline from its template, docstring-only.
@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) review: good-to-go Cross-review at the current head says ready; CI state is separate labels Nov 1, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

GOOD TO GO at c3da608f4. A Sonnet review covered the three content commits, and I checked the Registration Wrappers commit and the nit fold myself.

@JarryShaw JarryShaw moved this to In review in PyPCAPKit Nov 1, 2026
@JarryShaw
JarryShaw merged commit 5145a10 into main Nov 1, 2026
65 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Nov 1, 2026
@JarryShaw
JarryShaw deleted the docs/2551-registry-protocol-exceptions branch November 1, 2026 18:53
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Nov 1, 2026
JarryShaw added a commit that referenced this pull request Nov 1, 2026
…ons into 1.6.0 (#2449)

- Breaking: HTTP dispatches to HTTPv1/HTTPv2 on read, make and from_data,
  and so does a transport payload, whose data key moves from http to
  httpv1/httpv2; the members and their schema and data classes are renamed
  from httpv1.HTTP/httpv2.HTTP with no re-export; id() takes the RFC names;
  unrecognised transport payloads are Raw with no error (#2544).
- Changed: conventions record the dispatching base (#2544) and the
  case-fold exceptions (#2583); a project test guards every shipped
  module's documentation entry (#2584). Summary names the HTTP change.
- CHANGELOG.md regenerated; util/changelog_md.py --check passes.
@github-actions github-actions Bot added this to the PyPCAPKit v1.6 milestone Nov 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment