Repository navigation
docs: cut the root markdown documents to what a reader needs - #1011
Conversation
3cec753 to
73af823
Compare
|
NEEDS CHANGES at The one that matters landed on my own edit. The Four
One flagged uncertainty resolves the other way: Also corrected in the description: Citations remain frozen at the new head, and |
- `README.md`, `CONTRIBUTING.md` and `SECURITY.md` lose restatement, hedging and background that repeats the sentence above it. `CODE_OF_CONDUCT.md` is adapted Contributor Covenant 3.0 text and is left byte-identical. - `CONTRIBUTING.md` said `_make_data` is overridden in 28 protocol modules. The real count is 29. The figure is untested prose that rots silently, so it is dropped rather than replaced. - `CONTRIBUTING.md` called the `_missing_` population "the 121 enumerations". 121 is the registry count, not the enumeration count: 130 enumerations exist under `pcapkit.const`, 122 define `_missing_`, and 121 of the 127 `EnumRegistry` subclasses do. Reworded to "121 registries". - The same sentence said that fallback "resolves an unregistered value and registers it". It does not register, for all but one registry: `docs/source/contributing/conventions/mint-criterion.rst` records that exactly one `_missing_` in the tree mints, `CGAType`'s, while 114 unmint and six only range-check. The claim is dropped. - `README.md` said the module-structure page covers "the eight subpackages". There are nine with an `__init__.py`: const, corekit, dumpkit, foundation, interface, protocols, toolkit, utilities, vendor. - Drops timed context per #719 — "currently", "today", and the narrative about older commit prefixes. Version-bounded support notes and the version table stay. Issue and pull-request citations are untouched: the `#587`/`#597` multiset in `CONTRIBUTING.md` is byte-identical, and the other three files carry none. `tests/project`: 268 passed, 1 skipped, 864 subtests passed. Part of #719.
73af823 to
3031789
Compare
|
GOOD TO GO at One merge-order condition, and it is worth respecting. The reviewer could not read the sibling diff and flagged that as unverified, so I checked it myself: #1014 fixes both halves — the sentence now reads nine subpackages and a Vendor bullet is added, giving nine entries. So the condition is satisfied as long as #1011 and #1014 land in the same wave, or #1014 first. Nothing breaks if #1014 goes first and #1011 follows. Everything from the first two passes stands and could not be disturbed by a one-line README change: the four |
make pylint,make mypy,make isort) — N/A, no Python changedmake testpasses, and a test case covers the change — I rantests/projectonly (268 passed, 1 skipped, 864 subtests), not the full suitedocs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible — N/A, prose only, no user-visible behaviourWhat 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
The root-markdown slice of #719, one of the per-directory PRs that issue asks for. −38 lines across three files.
Two counts were wrong, and they are wrong in different ways.
_make_datawas said to be overridden in 28 protocol modules. Measured at runtime fromProtocolBase.__subclasses__(), 30 classes define it, one of which isProtocolBaseitself, across 29 distinct modules. Nothing pins that figure, so it will rot again — dropped rather than renumbered.The
_missing_passage said "the 121 enumerations". The number is right and the noun is wrong: 130 enumerations exist underpcapkit.const, 122 define_missing_, and 121 of the 127EnumRegistrysubclasses do — the 122nd isCommandType, a non-registry. So this now reads "121 registries", agreeing withconventions/mint-criterion.rst, whose figurestests/project/test_conventions_doc_claims.pyalready measures.The same sentence also claimed the fallback "resolves an unregistered value and registers it". It does not, for all but one registry:
mint-criterion.rstrecords that exactly one_missing_in the tree mints (CGAType's), while 114 unmint and six only range-check — and underpcapkit/const/, 111 files reference_unregistered_memberagainst 3 referencingextend_enum. The registering claim is dropped. A cross-review caught this in the very sentence I had rewritten to assert agreement.Citations are frozen. Per the ruling on #719 they are design rationale, not timed context. The
#587/#597multiset inCONTRIBUTING.mdis byte-identical; the other three files carry none. Timed context is cut — "currently", "today", the older-commit-prefix narrative — while version-bounded support notes and the version table stay.CODE_OF_CONDUCT.mdis untouched, byte-identical tomain. It is adapted Contributor Covenant 3.0 rather than verbatim — three passages are project-written (the reporting contacts, theSECURITY.mdpointer, and a paragraph on why the four-rung ladder was kept) — so it is left alone for now rather than claimed as exempt upstream text. Sweeping its project-written parts is a residual slice of #719, not closed here.Checked and found correct, so left alone: the
maketargets and flags, the 120/100 column stance, theLintjob's triggers and advisorycontinue-on-error, the changelog-drift gate, themake verminredirect trap, and the README usage block — which I re-ran against the committedexamples/captures/in.pcapwith every printed value matching.SECURITY.md's "1.4.x — current stable" was queried and is correct:v1.4.1.post2is the newest of 143 non-prerelease releases, every 1.5.0 tag being a beta.