Repository navigation
docs(protocols): tighten the internet-layer prose and cut timed context (#719) - #1035
Conversation
|
Cross-review verdict on
The Confirmed: the Nit, worth taking: the |
100fe88 to
fdde563
Compare
|
Cross-review verdict on
So Everything else is confirmed:
|
…xt (#719) Docstrings and comments only, in internet half A (mh, esp, ipv6, ip, __init__). - mh.py: the four RFC-inline enums lose their issue-by-issue history and state the closed-enumeration and no-`get`-override decisions once; the stale "AttributeError degrades the whole IPv6 packet" claim (and its wrong `ipv6.py` line reference) is replaced by what IPv6 now does, which is substitute IPv6_Ext for a Mobility Header that raises. Fix the `_read_option_`/`_read_extension_` registry comments to the real `_read_opt_`/`_read_ext_` names; drop "currently", issue tags and "used to" from the MH/MN-ID/QoS/CGA notes. - ipv6.py: describe the `__generic_ext_codes__` fallback and the structural `next` check as they are; drop the claim that MANIFEST.in excludes the Shim6 placeholder from the wheel. - esp.py, ip.py, __init__.py: drop issue citations and history; IP no longer lists AH/ESP (they derive from IPsec); "Deprecated / Base Classes" is "Base Classes". Prose only: AST with docstrings stripped equals origin/main for every file.
fdde563 to
a7dda2d
Compare
|
Cross-review verdict on
|
make testpasses, and a test case covers the change (N/A: prose only;tests/protocols/internet279 passed,tests/project268 passed)What is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
Internet-layer half A of the #719 prose sweep (
mh,esp,ipv6,ip,__init__; the other seven files needed nothing).mh.py: the four RFC-inline enums state the closed-enumeration and no-get-override decisions once, without the issue history. Their claim that an unassigned value degrades the whole IPv6 packet (with a staleipv6.pyline reference) is replaced by whatIPv6does now: substituteIPv6_Extfor the failing MH layer. Registry comments named_read_option_/_read_extension_, which do not exist (_read_opt_/_read_ext_). Issue tags, "used to", "currently" removed from the notes.ipv6.py:__generic_ext_codes__and the structuralnextcheck described as they are; dropped the claim thatMANIFEST.inexcludes the Shim6 placeholder from the wheel.ip.py: no longer lists AH/ESP (they derive fromIPsec);__init__.py: "Deprecated / Base Classes" is "Base Classes".esp.py: issue citations and history dropped; two headings recased.Checks: Sphinx
-n, 29 warnings on these files vs 37 onmain, none new. AST with docstrings and bare strings stripped equalsmainfor every file:internet/__init__.py,esp.py,ip.py,ipv6.py,mh.pyipsec.py,ipv6_frag.py,NotImplemented/{ecn,icmp,icmpv6,igmp,shim6}.py