Repository navigation
docs(repo): sixth whole-repo pass over the repository files (#1103) - #2215
Merged
Merged
Conversation
Prose only, per #1103's change-relative ruling: comments, docstrings and Markdown in the root files, .github/, util/, examples/ and conda/ state behaviour rather than the change that produced it. Also replaces the tcp.py:NNN anchors in CONTRIBUTING.md's commit example with names, and corrects stale claims: dispatch.py's KNOWN_DEGRADED (checked against the test's own copy, not this one) and IPX comments, options.py's TCP_BASE comment (UnsupportedCall, #617), pcapng.py's ISB option-area note and generate() default, the benchmark README's Samples column, and the Makefile's pointer to a lint.yml account that does not exist. AST guard clean on every changed .py; workflow YAML and TOML parse to identical data; related tests/project, tier-guard and generator tests pass.
JarryShaw
added
docs
Owner
Author
|
Review: GOOD TO GO at
|
JarryShaw
added
review: good-to-go
Owner
Author
|
Ready to merge at
|
Contributor
|
Coverage: 91.56% (unit tier, Python 3.15,
Per-file detail: the |
JarryShaw
removed
the
review: good-to-go
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 testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription
Part of #1103, round 6: the sixth whole-repo prose pass over the repository files:
.github/comments,util/,examples/,conda/,CONTRIBUTING.md, and the comments inpyproject.toml,MakefileandMANIFEST.in.release_*.py"formerly held this as shell" docstrings and theexamples/generators/defect sections.CONTRIBUTING.md's example commit citesTCP.makeand_make_mptcp_joinby name, nottcp.py:NNN.KNOWN_DEGRADED's comment: the assertions use the test's own copy, and the generator's copy is only counted.KNOWN_DEGRADED.HIP_COPIESis 1 since HIP parameter padding aligns the contents, not the record, so every parameter pcapkit emits is 4 (mod 8) octets #651.TCP_BASE: unknown keywords raiseUnsupportedCall(make silently discards undeclared keywords where schema construction warns, so a misspelling costs data rather than raising #617).examples/captures), the benchmark column (Samples), and a dead pointer inMakefile..pyfiles keep a docstring-stripped AST identical tomain.run:script or key changes.Makefile,MANIFEST.in,.shand.batdiffs are comment-only.tests/projectfiles that read these files give 1824 passed. The tier guard, docstring contract, dispatch registry and option generators give 346 passed.python-compatibility.yml, andgit merge-treemerges the two cleanly.