Repository navigation
docs: #719-style prose sweep after the #1090–#1102 defect wave #1103
Description
Is your feature request related to a problem? Please describe.
The defect wave #1090–#1102 changes code and docstrings in several modules, and #719's two rounds of prose sweeps predate those changes. The maintainer asked for another #719-style pass over the docs and comments once the wave lands.
Describe the solution you'd like
Re-read the prose that the wave's merged PRs touched or made stale: docstrings, comments, docs/ and pep.rst. Apply #719's rules: no churn, accuracy first, no timed context, and only prose changes, with an AST guard on every .py.
Blocked until
Every issue in #1090–#1102 is closed.
Describe alternatives you've considered
Folding the sweep into each fix PR was rejected: thirteen parallel PRs editing shared prose would conflict.
Activity
JarryShaw commentedon Oct 6, 2026
Add to this sweep:
ProtocolBase.pack()(protocol.py:559-576) rebuilds frommake(**kwargs)and ignores the instance's parsed or constructed state. A bareX(...).pack()therefore returns defaults. Neither the docstring nor the rst docs say so. This came up in the #1143 review.JarryShaw commentedon Oct 6, 2026
Add to this sweep, after #1147 merges:
docs/source/ext.rst:~266saysfrom_data"warnsUnknownFieldWarning" and that its keywords "come from your_make_data". Caller-supplied keywords now raiseUnsupportedCall._check_construction_keywordsdocstring describeskwargsas what remains after__init__.from_datacalls it as well now.JarryShaw commentedon Oct 6, 2026
Still blocked, with a new condition. Every issue in #1090–#1102 is closed, but the sweep is meant to run after all the defects the wave turned up are fixed, so that it reads the final docstrings once. It now unblocks when #1127, #1133, #1144, #1151, #1154, #1155 and #1156 are all closed.
JarryShaw commentedon Oct 7, 2026
Still blocked, with a new condition. All seven issues named in the last condition are now closed. Two more defects from the same audit are now being fixed, #1165 and #1167, and they edit
extraction.py,dumpkit/pcap.py,ipv4.pyandudp.py. The sweep unblocks once #1165 and #1167 are both closed, so it reads the final docstrings once.JarryShaw commentedon Oct 7, 2026
Condition extended: the #1169 cross-review turned up #1170, a defect in the same class that touches
ipv4.py,ipv6.py,udp.pyand the shared_import_next_layer. The sweep now unblocks once #1165, #1167 and #1170 are all closed.JarryShaw commentedon Oct 7, 2026
The previous condition is met: #1165, #1167 and #1170 are all closed. Two defects from the same audit are still in flight: #1172 (
l2tpv2.py) and #1173 (ipv6_route.py,mh.py,application.py). The sweep would read the docstrings of the files they edit, so it now unblocks when #1172 and #1173 are both closed. These are the last known items from this audit.JarryShaw commentedon Oct 7, 2026
Unblocked: #1172 and #1173 are both closed (#1174 and #1176 merged at 04:00Z and 04:01Z). Now
pending. Three later items are still open: #1175 (l2tpv2.py), #1177 (ipv6.py) and #1178 (ipv6_ext.py). The sweep skips those three files and they get a delta pass once each issue closes.JarryShaw commentedon Oct 7, 2026
Dispatched as three prose slices, each scoped to
git diff b10e7951b origin/main:protocols,schema-dataandfoundation-docs. The #1175/#1177/#1178 files are excluded.215 remaining items
JarryShaw commentedon Oct 29, 2026
Status: round 10 (full whole-repo pass) is in flight — the dispatched worker fanned out into several shard sub-agents per the sweep's own standing authorization, which are still running. No PR yet. Will post the outcome (clean / or a new PR) once it lands, and flip this to
blockedif a new PR or issue comes out of it.docs: #1103 round 10 -- close the whole-repo prose sweep (#2432)
JarryShaw commentedon Oct 29, 2026
Reopening — round 10 (merged as #2432 before review landed) got NEEDS CHANGES. Real finding: it reverted a ratified ruling from #1016/#2316 on the
RegistryErrormessage wording (should stay namingProtocol, notProtocolBase— the message's reader is a third party, and #2420 already caught this exact mistake once). Also a wrong :issue:/:pr: citation. Dispatching a follow-up PR to revert the message change and fix the citation.fix(protocols): revert #2432's RegistryError message to name Protocol (…
JarryShaw commentedon Oct 29, 2026
Closing. Round 10 (merged as #2432, before its review landed) found three issues — two of them real:
RegistryErrormessage change reversed the ratified fix(foundation): registrar error messages and type hints name the public class, not the Base the guard checks #1016/docs(protocols): register's Raises name Protocol in some layers, ProtocolBase in others #2316 ruling. Fixed by fix(protocols): revert #2432's RegistryError message to name Protocol #2434 (merged).:issue:/:pr:citation. Also fixed by fix(protocols): revert #2432's RegistryError message to name Protocol #2434.With #2434 merged, round 10's output is now clean: exactly the scope its own review verified (6 files, no scope creep, the
EnumFieldfix correct, tests and docs build unaffected), plus the two corrections above. That's a genuine whole-repo pass raising nothing new, same bar as #719.release: ship 1.5.0 final