Repository navigation
docs: second-round pass over the remaining Sphinx pages and root docs (#719) - #1085
Conversation
7ed6ffb to
86315bb
Compare
|
Cross-review verdict on
Everything else checks out:
Nit: emoji output appears only under |
…#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.
86315bb to
5d18405
Compare
|
Cross-review verdict on The delta from
UNVERIFIED: no Sphinx build. |
make pylint,make mypy,make isort) — N/A, docs-only (Sphinx -n and tests/project below)make testpasses, and a test case covers the change —tests/projectpasses uneditedWhat is the purpose of your pull request?
docs— documentation onlyDescription
Round two of #719 over every
docs/source/page outsideprotocols/andchangelog/, plusREADME.mdandCONTRIBUTING.md. Claims checked againstorigin/main; fixes where the code disagrees:pcapkit/index.rst: CLI help block regenerated frompcapkit-cli -h(adds-B/-Oand stdin-);emojiis optional, not required —__main__warnsEmojiWarningand prints plain text.ext.rst: reassembly callbacks run per submission with that submission's datagram list; flow-tracing callbacks get oneIndexper finalised flow.Dumper.kindis the format name, not the file extension.foundation/reassembly/tcp.rst: namesreassembly.tcp.TCP(notReassembly), adds its.. module::, and the packet example matchestoolkit.pcap.tcp_reassembly.ipv6.rstbuffer liststimestamp.pep.rst:LINUX_SLL2andQUICalso 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;releasetype in use).registry-protocol,protocol-layer-placement,sentinel-convention,documentation,releasing,workflows,pep.Sphinx
-b dummy -n, fresh output dirs, these pages: 66 warnings onmain, 65 here, none new (thetcp.rstpy:modone is gone).Every page in the slice has been read. On the templated
const/andvendor/pages the per-registry boilerplate was checked by-n, the hand-written prose by reading.