Repository navigation
docs(repo): third whole-repo pass over the repository files (#1103) - #1830
Merged
Merged
Conversation
Counted numbers: - Drop counts from workflow comments, the release-notes and coverage configs, README, CONTRIBUTING, MANIFEST.in, the Makefile, pyproject.toml comments, util/ docstrings, and the examples' docstrings and READMEs. - Replace lint.yml's finding tables with why the header keeps none; the measurements that justify a design choice stay, stated as measurements. - Keep the edits to line-cited files line-neutral, so the citations hold. Accuracy: - lint.yml: pcap-ct is also absent, so it is an import-error source too. - release.yml: dependencies PRs come from pyup and Dependabot, feat and fix never overlap each other, and the category is "Fixes". - CONTRIBUTING: which _OPT_Option siblings stay documented. - legacy.py's frame-range comments, _engine_support.py's engine claim and cron-conda.yml's stale create-release.yml line citation. Refs #1103
Owner
Author
|
Verdict: NEEDS CHANGES at
Two blocking defects, both re-checked on
These are workflow files, so the fix goes in a follow-up PR. |
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 elseCounted numbers:
configs, README, CONTRIBUTING, MANIFEST.in, the Makefile, pyproject.toml
comments, util/ docstrings, and the examples' docstrings and READMEs.
measurements that justify a design choice stay, stated as measurements.
Accuracy:
fix never overlap each other, and the category is "Fixes".
cron-conda.yml's stale create-release.yml line citation.
Non-prose check:
ast.dumpis unchanged once docstrings are blanked; any workflow, TOML or script edits are comment-only (parsed and compared). Narrow test runs are green (tests/projectand the tests that read edited files).Refs #1103