Skip to content

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

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1947-apptype-internal-refs
Oct 19, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1947-apptype-internal-refs

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

Links the internal references #1946 left in the AppType and OptionType templates, and documents the special methods whose entries rendered empty (#1947).

  • TransportProtocol and AppType.get() become roles; expression literals and # comments stay as they are.
  • Docstrings for AppType.__new__, __repr__, __str__, __int__, __eq__ and OptionType.__new__.
  • Edits are in the vendor templates; the const modules regenerate byte-identically from the committed crawled data.

tests/project/test_docs_internal_refs_1947_unit.py pins the roles, the docstrings and template/const docstring parity, and fails on main. The #1940 test drops its __eq__ exemption. The pinned docs build has no warnings.

Closes #1947

…d OptionType templates (#1947)

- Link TransportProtocol in AppType._dispatch and the crawler's flag
  docstring, and AppType.get in the per-transport __canonical__ comment
- Give AppType.__new__, __repr__, __str__, __int__, __eq__ and
  OptionType.__new__ docstrings, so their entries on reg.rst and pcapng.rst
  render text
- Edit the vendor templates and regenerate the const modules byte-identically
  from the committed crawled data
- Add a project test pinning the roles, the docstrings and their parity with
  the templates; drop the #1940 test's docstring exemption for AppType.__eq__

Closes #1947
@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) const Regenerated IANA or vendor constant tables; members keep their numeric values review: running A cross-review is in flight against the current head - no verdict yet labels Oct 19, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

GOOD TO GO at f46335132. A Sonnet review re-rendered all six const modules byte-identically, and its own capture of the crawled data matched the author's. With docstrings stripped, the const modules are AST-identical to main. The new docstrings match the code: AppType.__new__ raises ValueError only on the base registry. The roles resolve, and the dunders render on reg.html and pcapng.html with 0 warnings on the pinned docs venv. The new test fails on main's files (20 failed). tests/const, tests/vendor and the doc guards pass.

@JarryShaw JarryShaw added review: good-to-go Cross-review at the current head says ready; CI state is separate and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 19, 2026
@JarryShaw
JarryShaw merged commit e187166 into main Oct 19, 2026
12 checks passed
@JarryShaw
JarryShaw deleted the docs/1947-apptype-internal-refs branch October 19, 2026 18:53
@JarryShaw JarryShaw moved this to Done in PyPCAPKit Oct 19, 2026
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 19, 2026
@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

const Regenerated IANA or vendor constant tables; members keep their numeric values docs Pull requests that change documentation only (docs: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

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

1 participant