Repository navigation
docs: close the #719 sweep's last three leftovers (#719) - #1056
Merged
Merged
Conversation
Owner
Author
|
Cross-review verdict on
Nit (pre-existing, mirrored in |
This was referenced Oct 6, 2026
Closed
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.
make pylint,make mypy,make isort)make testpasses, and a test case covers the change (N/A: docstrings and one directive only;tests/project275 passed,tests/test_docstring_contract.py7 passed)What 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
Part of #719. It closes the sweep's last three leftovers:
registry.rstgains.. autofunction::forregister_protocol_code. feat(protocols): opt-in code= registration with enum-type inference for Protocol/ProtocolBase #570 exported it in three__all__lists but never documented it, soext.rst's:func:reference resolved to nothing. Its docstring now linksProtocolBaserather than the undocumented__init_subclass__, which would have added a new warning.utilities/logging.py: "pre-1.4" becomes "pre-1.5". The stderr handler is still attached atv1.4.1.post2, and Logging integration: make the logger a library citizen, and use it #384 first ships inv1.5.0a1.toolkit/*.py: all eight module docstrings claimed the functions return "with a flag". They return data orNone, and thepypcap/pcap_ctfunctions raiseUnsupportedCall. The docstrings now matchdocs/source/pcapkit/toolkit/*.rst, and thePCAP-NG-NGtypo is fixed.Sphinx (
-b dummy -n): 1290 warnings onmainand 1289 on this branch, so 0 are new and theregister_protocol_codeone is gone.Exprstripped,mainvs branch)pcapkit/toolkit/{dpkt,pcap,pcap_ct,pcapng,pypcap,pypcapfile,pyshark,scapy}.pypcapkit/foundation/registry/protocols.py,pcapkit/utilities/logging.py