Repository navigation
docs(docs): sweep the Sphinx pages for stale claims, toctree order and markup (#1103) - #1766
Merged
Merged
Conversation
…d markup (#1103) - Directives: versionchanged 1.5.0 on the install section for the narrowed all extra and the new dev extra (#910). - Toctrees: Utilities fourth in pcapkit/index.rst; OSPF under Application and Miscellaneous last in const and vendor; MH inside the IPv6 extension-header block. Conventions, foundation, corekit, misc and utilities preambles follow their toctree order. - ext.rst: from_data raises UnsupportedCall for caller keywords and warns only for keys from _make_data. - pep.rst, testing.rst, test-coverage.rst: NULL/LOOP/RAW link types are bound, EXPECTED_FAILURES is empty, SKIP holds three, CI runs the fixture tier, the dumper round trip is asserted, #1202 is closed. - protocol-layer-placement, process, registry-protocol and conf.py: figures re-measured against the tree. - Markup: nine bold spans that nested an inline literal split, three headings in Title Case, bare issue citations linked, timed wording removed. tests/project: 930 passed, 1 skipped. Refs #1103
Owner
Author
|
Verdict: GOOD TO GO at
|
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
docsslice. It follows the #719 rules: prose only, accuracy first, no churn and no timed context.all extra and the new dev extra (design: write down what belongs in the
allextra, and why #910).Miscellaneous last in const and vendor; MH inside the IPv6 extension-header
block. Conventions, foundation, corekit, misc and utilities preambles follow
their toctree order.
for keys from _make_data.
EXPECTED_FAILURES is empty, SKIP holds three, CI runs the fixture tier, the
dumper round trip is asserted, test: round-trip coverage for every protocol code, dumper and lossless path #1202 is closed.
re-measured against the tree.
in Title Case, bare issue citations linked, timed wording removed.
tests/project: 930 passed, 1 skipped.
Checks:
.pyfile.tests/projectgives 930 passed and 1 skipped, and every test that reads the edited paths passes.Not covered here; a round-2 PR follows: the CI-timing and GraalPy figures in workflows.rst, which were not re-derived, and the html-theme block of conf.py.
Refs #1103