docs: tighten demo.rst and the docs landing page (#719) - #954
Conversation
- demo.rst: cut hedging from the Basic Samples lead-in and fix "has two different access" in the CLI section. - demo.rst: correct the CLI transcripts at six sites. All three examples showed "🚨Loading"/"🍺Report" with no space; the real output has one, since pcapkit/__main__.py:135,143 emojizes ":police_car_light: Loading file ..." with the space inside the f-string. - index.rst: tighten the About comparison, the Engine Comparison opening and the pypcap/pcap_ct exclusivity note; drop "introduced" and "By now", which date prose that describes the present. - index.rst: fix "foundamental", "the gi repository", and a missing relative pronoun in the jspcapy note. - index.rst: restate the speed claim against the table it cites -- pcapkit's own engine is slower than five of the six third-party engines and faster than pyshark, which "not enough comparing to other popular extraction engines" did not say. Every toctree entry, every .. deprecated:: directive and every design-rationale note is untouched. All three demo.rst examples and all three CLI invocations were re-run against examples/captures/in.pcap. tests/project/test_conventions_doc_claims.py and its two siblings: 44 tests, 1 skipped, 0 failed.
|
GOOD TO GO at It verified the emoji fix the hard way rather than by reading the source: ran all three CLI invocations and hexdumped the output, getting On the speed claim it reached the same conclusion independently — five third-party engines faster than For the removals it grepped every cut line for Two nits accepted but not acted on, and I would rather say so than quietly fold them in:
One scope difference worth naming rather than calling an error: the body says 44 tests over three files, the review got 43 over two. Both are right at their own scope — it did not count Unverified by either of us: the Test Results benchmark figures and the engine-availability matrix. Neither is edited by this change. Labelled |
Please follow the guide below
make pylint,make mypy,make isort)make testpasses, and a test case covers the changedocs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible — N/A — documentation prose only, no library behaviour changeWhat is the purpose of your pull request?
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingchore— anything elseDescription of your pull request and other information
Second slice of #719, taking the two user-facing root pages #953 did not touch:
docs/source/demo.rstanddocs/source/index.rst. +29/−32.One real documentation defect, at six sites. All three CLI transcripts in
demo.rstshowed🚨Loadingand🍺Reportwith no space. The space is real:pcapkit/__main__.py:135,143emojizes":police_car_light: Loading file ..."with the space inside the f-string, andemoji.emojizesubstitutes the shortcode in place, so the output is🚨 Loading file .... Confirmed by running all three invocations againstexamples/captures/in.pcapand reading the raw bytes.One claim restated against the table it cites. Engine Comparison said
pcapkit's ~0.2 ms/packet was "not enough comparing to other popular extraction engines", which the Test Results table does not support —pcapkitat 0.2342 ms is slower thanpypcapfile,dpkt,pypcap,pcap_ctandscapy, and roughly eighty times faster thanpysharkat 18.8158. It now says slower than most of the engines below.Timed context removed: "introduced alternative extraction engines" and "By now
pcapkitsupports …", both of which date prose describing the present. Three typos went with it —foundamental,the gi repository, and a missing relative pronoun in thejspcapynote.Untouched, deliberately: every
toctreeentry, the.. deprecated:: 0.8.0directive, thebpc-poseur/pypcap-versus-pcap-ct/all-extra notes, and the preflight-check rationale. Those are design decisions a reader would otherwise undo, which #719 explicitly protects.docs/source/changelog.rstis excluded — its treatment is still an open question.Verification. All three
demo.rstPython examples and all three CLI examples re-run against the real capture;extract()'s keywords checked againstpcapkit/interface/core.py:73-86; the engine literals againstpcapkit/foundation/extraction.py:74-75; the eight module-structure parts, thepcapkit-cliscript name and thepcap-ct/libpcappins againstpyproject.toml.tests/project/test_conventions_doc_claims.pyplus its two siblings: 44 tests, 1 skipped, 0 failed, re-derived under plainunittestas well as pytest.Not verified: the Test Results benchmark figures themselves and the
bpc-poseurupstream line reference, both out of reach without installing engines or that package. Neither was edited.