Skip to content

docs(repo): fourth whole-repo pass over the repository files (#1103) - #1914

Merged
JarryShaw merged 3 commits into
mainfrom
docs/1103d-repo
Oct 19, 2026
Merged

JarryShaw merged 3 commits into
mainfrom
docs/1103d-repo

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

Please follow the guide below

What is the purpose of your pull request?

Tick the commit type your subject line carries.

  • fix — corrects a defect
  • feat — adds a feature
  • perf — changes performance, not behaviour
  • refactor — changes neither behaviour nor performance
  • test — tests only
  • docs — documentation only
  • ci — workflows or build tooling
  • release — bumps the version or rolls up a distribution
  • chore — anything else

The fourth whole-repo prose pass of #1103, over the repository-level files. It changes prose only: every changed .py file's AST is unchanged once string expressions are blanked, except where a docstring is added or vendor template text is edited together with its generated const file.

Accuracy:

  • legacy_smoke README and Makefile: timestamps render in UTC, not the
    host's zone, since Frame.packet and bytes(frame) return the next frame's bytes #357/PCAP-NG timestamp_epoch is shifted by the host timezone, not UTC #361; the TZ pin is belt-and-braces, measured.
  • benchmark README and requirements-pcap_ct.txt: a bare pip install pcap-ct resolves to the newest beta rather than to nothing.
  • generators/legacy.py: drop the test_analyse.py defect note (the script
    passes reassembly=True), and describe buffers, the final flush and
    completeness as tcp.py implements them.
  • unit-tests.yml: the changelog job's import list was stale; say
    "standard library only" instead.
  • conda_vendor.py, cron-conda.yml: the recipe's one run requirement is
    Python; lint.yml: vermin writes a verdict, not a count.
  • verdict_covers_checkout.py, run_unittest_leg.py, test_perf.py: name
    the pre-ci: use deploy key for protected maintenance pushes #401 commits as examples, align a timing with the workflow
    table, and use the PyPI name pypcapkit.

Counts and citations:

Refs #1103

Accuracy:
- legacy_smoke README and Makefile: timestamps render in UTC, not the
  host's zone, since #357/#361; the TZ pin is belt-and-braces, measured.
- benchmark README and requirements-pcap_ct.txt: a bare `pip install
  pcap-ct` resolves to the newest beta rather than to nothing.
- generators/legacy.py: drop the test_analyse.py defect note (the script
  passes reassembly=True), and describe buffers, the final flush and
  completeness as tcp.py implements them.
- unit-tests.yml: the changelog job's import list was stale; say
  "standard library only" instead.
- conda_vendor.py, cron-conda.yml: the recipe's one run requirement is
  Python; lint.yml: vermin writes a verdict, not a count.
- verdict_covers_checkout.py, run_unittest_leg.py, test_perf.py: name
  the pre-#401 commits as examples, align a timing with the workflow
  table, and use the PyPI name pypcapkit.

Counts and citations:
- Count-free wording for the #981 module pair, the DPKT-gated test list,
  the NGAP entry points and the docs-only reader comment.
- dispatch.py cites Raw.__post_init__ instead of a stale raw.py line;
  MANIFEST.in drops "today".

Refs #1103
@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) 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

NEEDS CHANGES at e25ee13a4. examples/legacy_smoke/README.md adds timed context ("did leak in before that fix"), so restate the timezone mismatch timelessly. Also check that #357 is the right citation next to #361, since its title is about Frame.packet, and rewrap the over-long lines in util/conda_vendor.py:3-8 and cron-conda.yml.

@JarryShaw JarryShaw added review: needs-changes Cross-review at the current head says changes are required; see the verdict comment and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 19, 2026
- legacy_smoke README: describe the zone disagreement through the copies
  #387 replaced, with no "before that fix" framing
- legacy_smoke Makefile and README: cite #361 and #403 for the UTC
  timestamps, not #357, which is the frame-bytes fix
- cron-conda.yml: restate the #1814 rationale without "once" and reflow
  the comment to its block's width
- conda_vendor.py: rewrap the over-long docstring line
- lint.yml: drop "current" from the run-summary note
- verdict_covers_checkout.py: name the pre-deploy-key commits as
  ancestors of bb90090 rather than "from before #401"
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 19, 2026
@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Oct 19, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

NEEDS CHANGES at 431800ecd. The citations now check out: #403 made the timestamps UTC and closes #361, and #357 was the wrong issue. One sentence is left. In examples/legacy_smoke/README.md, "the copies of these reports that #387 replaced" still tells the reader what the reports used to show. Restate it as a present-tense fact, for example that a host-zone leak makes the reports disagree (UTC-05:00 against UTC+08:00, with timestamp_epoch shifted 8 hours), or drop it.

@JarryShaw JarryShaw added review: needs-changes Cross-review at the current head says changes are required; see the verdict comment and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 19, 2026
- legacy_smoke README: drop the sentence on what the pre-#387 report
  copies showed; the identical-under-three-zones measurement carries
  the point, and the #361 and #403 citations stay
@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Oct 19, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

GOOD TO GO at d09478564. The flagged sentence is dropped, and the paragraph still reads cleanly. A Sonnet re-review regenerated every report under UTC, Asia/Shanghai and America/New_York and found them byte-identical, which is what the paragraph claims. It also confirmed that frame.py/pcapng.py never consult the host zone, and that the PR adds no timed context or codebase counts.

@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
@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 90.07% (unit tier, Python 3.15, d09478564, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 2 20 2 96.77%
pcapkit/const 19595 881 2618 867 92.11%
pcapkit/corekit 2504 70 792 36 96.54%
pcapkit/dumpkit 276 3 100 3 98.40%
pcapkit/foundation 2916 164 1016 34 93.59%
pcapkit/interface 138 7 52 5 93.68%
pcapkit/protocols 17411 224 4580 189 98.10%
pcapkit/toolkit 872 177 298 8 77.18%
pcapkit/utilities 522 2 158 4 99.12%
pcapkit/vendor 4431 2341 1018 156 43.64%

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

@JarryShaw
JarryShaw merged commit 0d91e8e into main Oct 19, 2026
57 checks passed
@JarryShaw
JarryShaw deleted the docs/1103d-repo branch October 19, 2026 14:43
@github-project-automation github-project-automation Bot moved this from In review 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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