Repository navigation
docs(repo): fourth whole-repo pass over the repository files (#1103) - #1914
Conversation
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
|
NEEDS CHANGES at |
- 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"
|
NEEDS CHANGES at |
|
GOOD TO GO at |
|
Coverage: 90.07% (unit tier, Python 3.15,
Per-file detail: the |
Please follow the guide below
You will be asked some questions, please read them carefully and answer honestly
Put an
xinto all the boxes [ ] relevant to your pull request (like that [x])Use Preview tab to see how your pull request will actually look like
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort)make testpasses, and a test case covers the change. Narrow runs only, listed below.Added a changelog entry under
docs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible: N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
Tick the commit type your subject line carries.
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingrelease— bumps the version or rolls up a distributionchore— anything elseThe fourth whole-repo prose pass of #1103, over the repository-level files. It changes prose only: every changed
.pyfile'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:
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.
pip install pcap-ctresolves to the newest beta rather than to nothing.passes reassembly=True), and describe buffers, the final flush and
completeness as tcp.py implements them.
"standard library only" instead.
Python; lint.yml: vermin writes a verdict, not a count.
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:
the NGAP entry points and the docs-only reader comment.
MANIFEST.in drops "today".
Refs #1103