Repository navigation
docs(corekit): second whole-repo pass over corekit, const and vendor (#1103) - #1808
Merged
Merged
Conversation
…1103) - Backfill directives, template and const alike: `OptionType` 1.1.0 and `AppType` 1.1.1 (int, compare, hash by code; `AppType`'s raised `AttributeError` until 1.1.1); `_Field` removed 1.3.0 (`field.py`, `field.rst`); `VersionInfo` str and `beholder` logging 1.3.0; `Info` iteration 1.3.3. - Stale claims: `PortEnumField`'s width check (`_missing_` never raises in width), its isinstance sites, `_validate_value`'s callers, the empty `FieldMeta`/`VendorMeta`, `Vendor` as a "meta class", and the IPX packet crawler, which does not crawl either. - Cross-references: `_missing_`, `ProtocolError`, `FieldValueError`, `struct`, `aenum.StrEnum`, the `APPTYPE` page links, `MH_CGAExtension` and vendor VLAN targets, and a role split across two `#:` lines. - Labels: `IPv6_ExtensionHeader`, `HTTP_StatusCode`; the vendor IPv4 table lists `TSFlag`. - Timed wording dropped from parts of the `AppType` template (const mirrored). - Typos: a stray period in `pcapkit.vendor`, "enumerate registry" x5. Template output matches both const modules. AST guard identical bar the two templates, identical with every string blanked. tests/project, const, vendor, corekit, dumpkit, foundation/registry and test_docstring_contract pass. Refs #1103
Owner
Author
|
Verdict: GOOD TO GO at
Each const file matches its vendor template, and the AST guard passes on all changed files. |
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 elseSummary
#1103 second whole-repo pass, corekit slice.
OptionType1.1.0 andAppType1.1.1 (int, compare, hash by code;AppType's raisedAttributeErroruntil 1.1.1);_Fieldremoved 1.3.0 (field.py,field.rst);VersionInfostr andbeholderlogging 1.3.0;Infoiteration 1.3.3.
PortEnumField's width check (_missing_never raisesin width), its isinstance sites,
_validate_value's callers, the emptyFieldMeta/VendorMeta,Vendoras a "meta class", and the IPXpacket crawler, which does not crawl either.
_missing_,ProtocolError,FieldValueError,struct,aenum.StrEnum, theAPPTYPEpage links,MH_CGAExtensionand vendor VLAN targets, and a role split across two
#:lines.IPv6_ExtensionHeader,HTTP_StatusCode; the vendor IPv4table lists
TSFlag.AppTypetemplate (constmirrored).
pcapkit.vendor, "enumerate registry" x5.Template output matches both const modules. AST guard identical bar the
two templates, identical with every string blanked. tests/project,
const, vendor, corekit, dumpkit, foundation/registry and
test_docstring_contract pass.
Refs #1103