Repository navigation
docs(contributing): sweep the conventions pages for accuracy and concision (#719) - #968
Conversation
…ision (#719) Accuracy fixes, each re-derived against the code: - mint-criterion.rst presented `EtherType`'s company names and `Socket`'s `Registered by Xerox` as the worked *mint* examples. #878 converted both to `_unregistered_member`; `CGAType` is now the only `_missing_` that mints, so the criterion decides the unregistered member's *name*, not whether it registers. - Its `ast` snippet matched only `ast.Name` callees, so it reported 1 MINT and 0 UNMINT; `_unregistered_member` is called on `cls`. Matches attributes now. - "Every registry defines `_missing_`" -> 121 of 127, naming the six without one. - registry-protocol.rst: `__new__` exemption said "a handful ... tracked in #860"; it is six named classes and #860 closed with all 127 on the base. - The 6 mh/ngap helpers are not all numeric: `PDUKind` is `str`, and it was listed in two rows at once. - `TCP`/`UDP`/`SCTP`/`DCCP` member *names* come from the service-name column; the values are composites. - process.rst: 9 sections, 8 of them module-level; `pcapkit.interface` has none. - sentinel-convention.rst: `NO_VALUE` also lacks `__copy__`/`__deepcopy__`/ `__reduce__`; the quoted `AbsentType` excerpt did not support the privacy claim it was cited for. - Two `/issues/` links pointed at pull requests (#847, #913). Concision: dropped timed context (the page's former title, the two-pass #877 history, the pre-#937 casing narrative, the pre-restructure changelog shape) and fixed a duplicated clause. Added two Mermaid flows for `_missing_` and for `get`'s dispatch, modelled on workflows.rst:102. Build: docutils parse unchanged from base; tests/project/test_conventions_doc_claims.py and the seven other suites reading these pages 111 passed, 1 skipped, 241 subtests.
06b8eac to
e595d26
Compare
|
NEEDS CHANGES at
I re-derived it against the live registry rather than taking the review's word: Not a scoping choice:
The review separately confirmed, against live sources, |
|
GOOD TO GO at The Round 2 also closed the sub-claim round 1 had time-boxed out. Running the page's Residuals it names rather than papers over: three of the six flag bodies were |
Please follow the guide below
make pylint,make mypy,make isort) — N/A,.rstonlymake testpasses, and a test case covers the change — the eight suites reading these pages: 111 passed, 1 skipped, 241 subtestsdocs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible — N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
The
docs/source/contributing/conventions/slice of #719. Factual corrections, each re-derived against the tree:EtherType's company names /Socket'sRegistered by XeroxmintCGATypeis the only minting_missing_, so the criterion decides the namepcapkit/const/reg/ethertype.py:540,pcapkit/const/ipx/socket.py:83,pcapkit/const/mh/cga_type.py:54,pcapkit/vendor/ipx/socket.py:253-261,pcapkit/corekit/enum.py:249-254astsnippet (ast.Nameonly)_missing_"pcapkit/const/**__new__, "tracked in #860"pcapkit/const/ftp/command.py:266et al.PDUKind's arestr— and it was in two table rowspcapkit/protocols/application/ngap.pyTCP/UDP/SCTP/DCCP"values are service names"'tcpmux [1 - tcp]'pcapkit/const/reg/apptype/tcp.pypcapkit.interfacehas nonedocs/source/changelog/1.5.0.rstNO_DEFAULTandABSENTlack__copy__/__deepcopy__/__reduce__NO_VALUEdoes too, and the consequences differpcapkit/corekit/sentinels.py:158,162,173AbsentTypedocstring quoted as saying it is privatepcapkit/corekit/sentinels.py:439-466/issues/847,/issues/913/pull/— both are pull requestsissueOrPullRequestConcision: dropped timed context (the page's former title, #877 phase 2's two-pass history, the pre-#937 casing narrative, the pre-restructure changelog shape), fixed
has its own status of its own, softened two unquantified "most" claims, and added two Mermaid flows —_missing_'s outcomes andget's dispatch — modelled oncontributing/workflows.rst:102.Net +21 lines, so this slice did not get shorter: 22 of those are the two Mermaid blocks and
mint-criterion.rstgrew 30, the corrected worked examples needing more words than the wrong ones did (sentinel-convention.rst−16,process.rst−5,index.rst−3).docutilsreports the same two INFO diagnostics as the base and no new ones.