Repository navigation
docs(protocols): Protocol docstring claims it is the base of all protocol families - #1106
Merged
Merged
Conversation
…ocol families - Protocol: describe it as the user-facing base for third-party protocols and new protocol stacks; built-in families derive from ProtocolBase. - ProtocolBase: name the families that derive from it and its metaclass. - ProtocolMeta: it is ProtocolBase's metaclass and adds nothing over abc.ABCMeta; drop the claim that it generates attributes for Protocol. Docstrings only; AST identical to origin/main once bare-string Exprs are stripped. Closes #1101
Owner
Author
|
Cross-review verdict on
UNVERIFIED: no Sphinx build was run, so the |
Contributor
|
Coverage: 88.74% (unit tier, Python 3.14,
Per-file detail: the |
JarryShaw
added a commit
that referenced
this pull request
Oct 6, 2026
- 22 new 1.5.0 entries for the 30 PRs merged since b10e795 (#1106-#1158), with related fixes grouped per the #918 ruling; three marked breaking to match their labels (#1116, #1138, #1145) - regenerate CHANGELOG.md with util/changelog_md.py - process.rst: entry-count pin re-measured, 167 -> 189 - pep.rst: note the plist round-trip test skipped on the upstream dictdumper fractional-second <date> defect (DictDumper#122) tests/project: conventions_doc_claims, changelog_md and documentation_claims pass; changelog_md.py --check is in step.
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) — not run; docstrings onlymake testpasses, and a test case covers the change — rantests/test_docstring_contract.pyandtests/projectonly; no new test, a docstring change has no failing-without-fix testdocs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible — N/A, added centrally after the waveWhat 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
Closes #1101.
Before:
Protocolsaid "Abstract base class for all protocol family", butProtocol.__subclasses__()is[];ProtocolMetasaid it supportsProtocoland generates attributes for it, but its body is empty and it isProtocolBase's metaclass.After:
Protocolis the user-facing base for third-party protocols and new protocol stacks;ProtocolBasenames the families that derive from it directly (Link,Internet,Transport,Application,pcapkit.protocols.misc) and its metaclass;ProtocolMetasays it adds nothing overabc.ABCMeta. Wording followsdocs/source/ext.rstanddocs/source/pcapkit/protocols/protocol.rst.Evidence
Exprstripped,ast.dump(include_attributes=False)) vsorigin/mainb10e7951b: identical.tests/test_docstring_contract.py:7 passed, 12 subtests passedtests/project:379 passed, 1 skipped, 1285 subtests passed