Repository navigation
docs: prose sweep after the defect wave (foundation-docs) (#1103) - #1186
Merged
Merged
Conversation
- extraction.py: _open_output names which engines pass header fields (PCAP does, PCAP-NG passes none); run() lists the PCAP-NG/PCAP FormatError; _ofile's comment covers its class/writer/factory states. - engines/pcapng.py: run() documents its two FormatErrors. - dumpkit/pcap.py: PCAPIO's **kwargs names thiszone/sigfigs/snaplen. - dumpkit/common.py: a backslash in a JSON key escapes, not closes. - all.py: drop the commit and date from the utilities comment. - docs: extraction page documents _open_output and _flag_o; the engine gap table gains the PCAP-output rows; ext.rst's PoC engine calls record_header like the real Scapy engine. Comments, docstrings and .rst only; AST guard True for every .py.
Contributor
|
Coverage: 88.89% (unit tier, Python 3.14,
Per-file detail: the |
Owner
Author
|
Cross-review verdict on
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please follow the guide below
make pylint,make mypy,make isort) — not run; comments and docstrings onlymake testpasses, and a test case covers the change —tests/projectonly (389 passed, 1 skipped)What is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
Part of #1103: the
foundation-docsslice of the post-wave prose sweep.Extractor._open_output: only the PCAP engine passes header fields; PCAP-NG passes none.run()andPCAPNG.run()now list the PCAP-output-on-PCAP-NGFormatError(probed)._ofilecomment,PCAPIO**kwargs, and the JSON-key NOTE (\escapes,"closes) brought in line with the code; timed context cut fromall.py._open_output/_flag_odocumented on the extraction page; the engine gap table gains the PCAP-output rows; theext.rstPoC engine callsrecord_headeras the real Scapy engine does.pep.rst,process.rst,httpv2.rst,ospf.rst,tcp.rstchecked againstorigin/main: no change needed.Sphinx
-b dummy -n, fresh dirs, warnings on these files: main 117, branch 116, none new.pcapkit/all.pypcapkit/dumpkit/common.pypcapkit/dumpkit/pcap.pypcapkit/foundation/engines/pcapng.pypcapkit/foundation/extraction.py