Skip to content

docs: second-round pass over the remaining Sphinx pages and root docs (#719) - #1085

Merged
JarryShaw merged 1 commit into
mainfrom
docs/719-r2-sphinx-rest
Oct 6, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/719-r2-sphinx-rest

Conversation

@JarryShaw

@JarryShaw JarryShaw commented Oct 6, 2026 •

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Round two of #719 over every docs/source/ page outside protocols/ and changelog/, plus README.md and CONTRIBUTING.md. Claims checked against origin/main; fixes where the code disagrees:

  • pcapkit/index.rst: CLI help block regenerated from pcapkit-cli -h (adds -B/-O and stdin -); emoji is optional, not required — __main__ warns EmojiWarning and prints plain text.
  • ext.rst: reassembly callbacks run per submission with that submission's datagram list; flow-tracing callbacks get one Index per finalised flow. Dumper.kind is the format name, not the file extension.
  • foundation/reassembly/tcp.rst: names reassembly.tcp.TCP (not Reassembly), adds its .. module::, and the packet example matches toolkit.pcap.tcp_reassembly. ipv6.rst buffer lists timestamp.
  • pep.rst: LINUX_SLL2 and QUIC also lack stubs; checksum half waits on the pseudo-header class (already settled), not an open question.
  • process.rst (five pages precede it), index.rst (cd PyPCAPKit), CONTRIBUTING.md (vermin's 3.11 is detected, not the floor; release type in use).
  • Timed context cut in registry-protocol, protocol-layer-placement, sentinel-convention, documentation, releasing, workflows, pep.

Sphinx -b dummy -n, fresh output dirs, these pages: 66 warnings on main, 65 here, none new (the tcp.rst py:mod one is gone).

Every page in the slice has been read. On the templated const/ and vendor/ pages the per-registry boilerplate was checked by -n, the hand-written prose by reading.

@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) review: pending No verdict for the current head - never reviewed, or the head moved since the last one labels Oct 6, 2026
@JarryShaw
JarryShaw force-pushed the docs/719-r2-sphinx-rest branch from 7ed6ffb to 86315bb Compare October 6, 2026 17:23
@JarryShaw
JarryShaw marked this pull request as ready for review October 6, 2026 17:23
@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: pending No verdict for the current head - never reviewed, or the head moved since the last one labels Oct 6, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Cross-review verdict on 86315bb66: NEEDS CHANGES (ran on Sonnet; author Opus). There is one fix to make.

foundation/reassembly/tcp.rst:164-184 adds raw_len = len(tcp.packet.payload) but never uses it. len, last and payload are still built from tcp.raw_len and tcp.raw, and neither attribute exists. toolkit/pcap.py:168-187 uses raw_len and bytearray(tcp.packet.payload), so the example should match it.

Everything else checks out:

  • The CLI help block matches python -m pcapkit -h exactly.
  • emoji really is optional (__main__.py:29-33, :136, :144).
  • ext.rst describes the callbacks correctly: per submit() at ip.py:371 and tcp.py:551, and per finalised Index at traceflow/tcp.py:455.
  • Dumper.kind is the format name, with the extension coming from ext=.
  • The new .. module:: is unique.
  • Buffer.timestamp exists.
  • The pep.rst stub, DTLS and checksum claims match the code.
  • tests/project passes 379.

Nit: emoji output appears only under -v. UNVERIFIED: the Sphinx build, which the reviewer did not run.

@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 6, 2026
…#719)

Correct claims the tree contradicts, and cut leftover timed context:

- pcapkit/index.rst: regenerate the CLI help block from `pcapkit-cli -h`
  (it lacked -B/-O and stdin input); emoji is optional, not required.
- ext.rst: reassembly callbacks get each submission's datagram list, flow
  tracing callbacks one Index per finalised flow; Dumper.kind is the format.
- foundation/reassembly/tcp.rst: name reassembly.tcp.TCP, declare its
  module, and match the packet example to toolkit.pcap; ipv6.rst lists the
  buffer's timestamp.
- pep.rst: LINUX_SLL2 and QUIC also have no stub; the checksum half waits on
  the settled pseudo-header class, not an open question.
- process.rst: five convention pages precede it, not four.
- index.rst: the clone lands in `PyPCAPKit`, not `pypcapkit`.
- CONTRIBUTING.md: 3.11 is vermin's detected minimum, not the code's floor;
  `release` is a commit type in use.
- registry-protocol, protocol-layer-placement, sentinel-convention,
  documentation, releasing, workflows, pep: state what the code does now
  rather than when it changed.

Sphinx -n warnings on these pages: 66 on main, 65 here, none new.
tests/project passes unedited.
@JarryShaw
JarryShaw force-pushed the docs/719-r2-sphinx-rest branch from 86315bb to 5d18405 Compare October 6, 2026 17:31
@JarryShaw JarryShaw added review: pending No verdict for the current head - never reviewed, or the head moved since the last one 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 review: pending No verdict for the current head - never reviewed, or the head moved since the last one labels Oct 6, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Cross-review verdict on 5d184056b: GOOD TO GO (ran on Sonnet; author Opus, round 2)

The delta from 86315bb66 touches only tcp.rst and index.rst.

  • The tcp.rst packet example now matches toolkit/pcap.py:162-187 field for field, and no tcp.raw_len or tcp.raw remains on the page. I re-checked this against the code myself.
  • The emoji note now says it decorates only the -v output, which matches __main__.py:133-146.
  • The round-1 findings stand. See the previous verdict.

UNVERIFIED: no Sphinx build. tests/project was run by the worker on this head (379 passed).

@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 6, 2026
@JarryShaw
JarryShaw merged commit 30e42d1 into main Oct 6, 2026
28 checks passed
@JarryShaw
JarryShaw deleted the docs/719-r2-sphinx-rest branch October 6, 2026 17:39
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 6, 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