Skip to content

docs(repo): seventh whole-repo pass over util, examples, workflows and root files (#1103) - #2260

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103-r7-repo-pr
Oct 26, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1103-r7-repo-pr

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Part of #1103, round 7. A full read of util/, examples/, workflow comments and root config. Comments and docstrings only: the AST guard is identical on all 22 .py files, no step or job is renamed, and actionlint is clean.

  • util:
    • changelog_md: the sdist keeps the per-version changelog.
    • pyshark_encap_map: an unknown DLT gets an unregistered Unassigned member; lxml is CPython-only.
    • pytest_shards: the PyPy leg runs on its own interpreter.
    • python_versions: only the *-ktlo outputs carry a KTLO version.
    • Claims in release_tags, vendor_test_gate, update_python_versions and superseded are corrected.
  • examples: HIP/SMF_DPD/PCAP-NG notes in options.py, the logging claims in pcapng.py, dispatch.py, legacy.py, engine lists.
  • workflows: unittest-ordering cap comments (the stale "8.2m"), the lint schedule, a leftover deploy-pages comment, the milestone.yml duplicate-closed case, and status_for cited by name.
  • root: the Makefile's captures note, the pyproject test-extra comment, .gitignore wording.
  • Throughout: change-relative wording and counts are restated.
  • Tests: every test that reads a changed file passes (109 workflow-reading modules alone: 1845 passed).

@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 2026
@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) ci Pull requests that change CI or workflow configuration (ci: subject prefix) review: running A cross-review is in flight against the current head - no verdict yet labels Oct 26, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 26, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at 244bd777a (Sonnet).

  • Comments only: the AST guard with docstrings stripped is identical on all 22 .py files. YAML, Makefile, toml and .gitignore change only in comments. actionlint is clean on all 9 changed workflows.
  • Claims: each claim checked against the tree holds:
    • MANIFEST.in keeps docs/source/changelog;
    • LinkType(121) returns an unregistered Unassigned, and lxml is CPython-only;
    • pytest_shards runs on the PyPy leg's own python;
    • only the *-ktlo outputs carry a KTLO version;
    • "Test gate" runs on workflow_dispatch;
    • NOT_PLANNED includes duplicate;
    • git ls-files examples/captures lists in.pcap and dhcp.pcapng;
    • the IPX socket test is LATEST tier;
    • the options.py, pcapng.py and legacy.py notes;
    • the ordering cap comments match ci_timing.py H2.
  • Tests: 107 modules that read changed files, plus the docstring contract, all pass across three batches. No text pins.

@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 26, 2026
…d root files (#1103)

Full read of util/, examples/, workflow comments and root config.

- util: changelog_md sdist scope, pyshark_encap_map Unassigned handling and
  lxml markers, pytest_shards interpreter, python_versions KTLO outputs,
  release_tags/vendor_test_gate/update_python_versions/superseded claims.
- examples: options.py HIP/SMF_DPD/PCAP-NG notes, pcapng.py logging,
  dispatch.py, legacy.py, engine lists.
- workflows: unittest-ordering cap comments, lint schedule, deploy-pages
  leftover comment, milestone duplicate-closed, status_for cited by name.
- root: Makefile captures, pyproject test extra, .gitignore wording.
- Change-relative wording and counts restated throughout.
@JarryShaw
JarryShaw force-pushed the docs/1103-r7-repo-pr branch from 244bd77 to 5da8d5e Compare October 26, 2026 19:27
@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: good-to-go Cross-review at the current head says ready; CI state is separate labels Oct 26, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at 5da8d5e4a (Sonnet delta review of 244bd777a→5da8d5e4a).

@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 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 91.56% (unit tier, Python 3.15, 5da8d5e4a, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 2 95.16%
pcapkit/const 19599 881 2618 867 92.11%
pcapkit/corekit 2589 74 816 37 96.51%
pcapkit/dumpkit 282 3 102 3 98.44%
pcapkit/foundation 3023 23 1044 25 98.82%
pcapkit/interface 138 4 52 3 96.32%
pcapkit/protocols 17437 218 4586 185 98.15%
pcapkit/toolkit 869 36 298 10 95.20%
pcapkit/utilities 504 7 146 5 98.15%
pcapkit/vendor 4432 1988 1018 167 51.87%

Per-file detail: the coverage-html artifact of this run.

@JarryShaw
JarryShaw merged commit 6ceed63 into main Oct 26, 2026
62 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 26, 2026
@JarryShaw
JarryShaw deleted the docs/1103-r7-repo-pr branch October 26, 2026 20:26
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Pull requests that change CI or workflow configuration (ci: subject prefix) docs Pull requests that change documentation only (docs: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant