Repository navigation
docs(corekit): third whole-repo pass over corekit, const and vendor (#1103) - #1837
Merged
Merged
Conversation
…1103) Counted numbers: - Drop tallies of methods, tiers, registries, sentinels, decorators, attributes, call sites, crawlers and table rows from corekit and vendor prose, rewording each sentence count-free. - Edit the apptype, FTP and HTTP vendor templates and apply the same text to the const modules they generate, including the shipped-member tally in AppType.__str__. Accuracy: - seekset and beholder decorate instance methods; _TP is bound to ProtocolBase; Info's page documents dict_ rather than *args. - AppType.get_all answers a miss with an unregistered member, not a mint; register_alias and aliases no longer contradict themselves. - Drop "as before", "this fix" and "above" where timed or wrong. Rendering: - Document FinalisedState, nested_packet_context and DecodedString so their cross-references resolve; link the PeekableStream issues. - Drop the duplicated ProtoChain parameters, the intersphinx prefix on strings._T and the inherited LINK on the NGAP page; fix typos. Refs #1103
Owner
Author
|
Verdict: NEEDS CHANGES at
One blocking defect, re-checked with docutils. In |
- infoclass.rst: escape `dict\_` so docutils stops reading it as a link target, and say that `__init__` does not rebuild annotated nested values - vendor/ngap/procedure_code.py: point the `LINK` reference at `Vendor.LINK`, which is documented - vendor/__main__.py: smooth the sentence contrasting the two decline paths - const/ngap/__init__.py: drop a stray comma and name the module cited Refs #1103
Owner
Author
|
Verdict: GOOD TO GO at
|
Contributor
|
Coverage: 90.05% (unit tier, Python 3.15,
Per-file detail: the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please follow the guide below
You will be asked some questions, please read them carefully and answer honestly
Put an
xinto all the boxes [ ] relevant to your pull request (like that [x])Use Preview tab to see how your pull request will actually look like
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort)make testpasses, and a test case covers the change. Narrow runs only, listed below.Added a changelog entry under
docs/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?
Tick the commit type your subject line carries.
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingrelease— bumps the version or rolls up a distributionchore— anything elseCounted numbers:
attributes, call sites, crawlers and table rows from corekit and vendor
prose, rewording each sentence count-free.
to the const modules they generate, including the shipped-member tally
in AppType.str.
Accuracy:
ProtocolBase; Info's page documents dict rather than *args.
register_alias and aliases no longer contradict themselves.
Rendering:
their cross-references resolve; link the PeekableStream issues.
strings._T and the inherited LINK on the NGAP page; fix typos.
Non-prose check:
ast.dumpis unchanged on every.pyfile with docstrings blanked. The four vendor templates are unchanged with every string blanked, and each edit to a generatedpcapkit/const/module traces to its template. Theconst/*/__init__.pymodules are hand-written. Narrow test runs are green (tests/vendor,tests/const,tests/corekit,tests/project).Refs #1103