Skip to content

docs(const): link aenum through the epilog in the apptype and option_type templates (#1920) - #1945

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1920-vendor-aenum-roles
Oct 19, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1920-vendor-aenum-roles

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

Converts the aenum roles left in the AppType and OptionType templates and their const modules (#1920). The package mention becomes |aenum|_ (#1936); member names and # comments become qualified literals (#934 part C). Both const modules regenerate byte-identically from the committed crawled data.

The #1919 and #1936 guards no longer exclude these files. With main's four files swapped in, the #1919 guard fails on every converted site. The tier guard, tests/const, tests/vendor and tests/project pass, and the pinned docs build has 0 warnings.

Closes #1920

…type templates (#1920)

- Write the package-level aenum mention in the AppType docstring as |aenum|_,
  the rst_epilog link (#1936), and demote member-level aenum roles in the
  AppType and OptionType templates to qualified literals (#934 part C).
- Regenerate pcapkit/const/reg/apptype/apptype.py and
  pcapkit/const/pcapng/option_type.py byte-identically from the committed
  crawled data.
- Lift the template and pcapkit/const/ exclusions from the #1919 and #1936
  guards, so both now scan these files.

Closes #1920
@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 20d00990c. A Sonnet review re-rendered both templates and got byte-identical const modules. It restored main's four files and the #1919 guard failed on them. A grep finds no aenum role left under pcapkit/. Tier guard, both guards, tests/const and tests/vendor pass. The |aenum|_ link was read from the author's 3.15.0 build; main's docs CI will render it on the 3.17.2 pin.

@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 1b0aa99 into main Oct 19, 2026
13 checks passed
@JarryShaw
JarryShaw deleted the docs/1920-vendor-aenum-roles branch October 19, 2026 17:55
@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 moved this to Done in PyPCAPKit 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: roles naming aenum, pcapfile, pyshark and pcap still render as unresolved chips outside conventions.rst

1 participant