You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 8f3f3e5
Browse filesBrowse the repository at this point in the historyBrowse files
docs: #719-style prose sweep after the #1090-1102 defect wave (#2408)
#1103 whole-repo prose sweep over the maker-message wave (#2296, #2404, #2405,
#2407) and the __proto_dest__ registry refactor (#2392, #2403).
Docstrings corrected where the prose did not match the code:
* ``Protocol`` -> ``ProtocolBase`` in the ``register``/``register_protocol``
cross-references (protocol.py, internet.py, link.py, transport.py, sctp.py,
registry/protocols.py).
* ``Raises:`` entries for the ``bool`` port guard (#2287) in TCP, UDP and SCTP
``make``, and for HTTP/1's request-without-``uri`` guard.
* ``protochain`` documented on both sides of its narrowing to ``None``
(protocol.py, misc/null.py, #2317), and ``__init__`` names the
``__own_make_keywords__`` exception to its keyword check.
* IP reassembly names the IPv6 ``M`` bit and which buffer an atomic fragment is
isolated from (#2270); ``_check_code`` names ``register_protocol_code`` among
its callers (#2186).
* HIP's shared lifetime helper says where the octet appears instead of counting
the makers that carry it, and ``_make_opt_pad`` warns and makes a ``PadN``
rather than raising as its reader does.
Before/after narration replaced with present tense, the pattern #1103's round 6
banned:
* the ``__proto_dest__`` prose in the registration and vendor tests, and the
``register_protocol_code`` key-check narration;
* the #2296 and #2406 maker-message module docstrings -- readers are exempt by
design rather than "deliberately untouched", and the HTTP ``frame=None`` case
is outside the guard rather than one the guard "has not widened to";
* the ``_NameLease`` rationale and the ``register_protocol`` name-collision
note in registry/protocols.py, which described a fix and a redesign in the
past tense;
* TCP's ``_make_mptcp_unknown`` length comment, which contrasted the current
expression with "the former" one.
AST guard (``ast.dump`` via util/vendor_code_changed.py's ``code_of``, with
docstrings and bare string literals stripped) confirms all 16 touched files are
prose-only against e48062c. 129 tests pass (1 pre-existing skip) with 334
subtests across the four touched test modules, tests/test_docstring_contract.py,
tests/project/test_conventions_doc_claims.py,
tests/project/test_docs_issue_pr_roles_1103_unit.py and
tests/project/test_issue_refs_in_comments.py.
0 commit comments