Repository navigation
docs(corekit): version directives and render fixes (#1103) - #1762
Merged
Merged
Conversation
Version directives, all 1.5.0: - versionadded: corekit.enum, .sentinels, .decorators, .fields.byteorder, parse_ip_address, PortEnumField, MultiInfo, OrderedMultiInfo, TLSKeyLabel. - versionchanged: FieldBase.length/unpack, SeekableReader, info_final, Info.to_dict, EnumField.post_process, OptionField.unpack, the ipaddress fields, OrderedMultiDict.deepcopy, and the generated Flags, ExtensionHeader and Method (template and output alike). - versionremoved: SeekableReader.writeable, field.NoValue and utilities.decorators; the beta-only _READ_CHUNK and zero-pad directives go. Rendering: cross-reference targets split across lines are joined, the NO_DEFAULT and AppType targets point at their documented homes, enum.rst and infoclass.rst stop rendering five members twice, and the SMF_DPD bold title no longer nests a literal. Prose: timed context is rewritten in sentinels, numbers, collections, io, the ExtensionHeader crawler and the decorators page. Refs #1103
Owner
Author
|
Verdict: GOOD TO GO at
|
4 of 13 tasks
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 elseDescription
Part of #1103, the whole-repository prose sweep, for the
corekitslice. It follows the #719 rules: prose only, accuracy first, no churn and no timed context.Version directives, all 1.5.0:
parse_ip_address, PortEnumField, MultiInfo, OrderedMultiInfo, TLSKeyLabel.
Info.to_dict, EnumField.post_process, OptionField.unpack, the ipaddress
fields, OrderedMultiDict.deepcopy, and the generated Flags,
ExtensionHeader and Method (template and output alike).
utilities.decorators; the beta-only _READ_CHUNK and zero-pad directives go.
Rendering: cross-reference targets split across lines are joined, the
NO_DEFAULT and AppType targets point at their documented homes, enum.rst and
infoclass.rst stop rendering five members twice, and the SMF_DPD bold title
no longer nests a literal.
Prose: timed context is rewritten in sentinels, numbers, collections, io, the
ExtensionHeader crawler and the decorators page.
Checks:
.py: code is identical once docstrings are blanked.The
pcapkit/vendor/**diffs change template strings, not docstrings. Each change is prose that the template emits into a generatedpcapkit/const/**docstring, and the generated files carry the identical change.tests/projectand every test that reads the edited paths pass.Not covered here; a round-2 PR follows: most of corekit (fields/misc, fields/strings, module, protochain, version and others), the vendor and const docstrings, and the timed wording left in vendor comments.
Refs #1103