Repository navigation
docs: cite each number by its kind, and fix heading and Mermaid forms - #2626
Merged
Merged
Conversation
…Mermaid forms (#2561) - Cite a ruling from a pull request's review by the issue it closes, or by :pr: with no issue holding it, on the convention, pep, workflows and releasing pages and in the vendor/default and ip_pseudo doc text. - Rename finite-verb headings on the warnings, logging, ext and layer placement pages, repoint the protocols graph's click target, re-case lowercase content words in const, vendor and protocol titles, and escape the leading underscores in two Mermaid node labels. - The 1103 test checks each role's kind against a snapshot, skipping numbers above it; util/issue_pr_kinds.py regenerates it, and the new Issue and PR Kinds workflow proposes a refresh as a pull request. Closes #2561.
JarryShaw
added
docs
JarryShaw
added
ci
Owner
Author
|
GOOD TO GO at
|
JarryShaw
removed
the
review: good-to-go
JarryShaw
added a commit
that referenced
this pull request
Nov 2, 2026
… kinds into 1.6.0 (#2449) - Added: pad_length and PaddingField's align/after form (#2624), and pcapkit.utilities.contextvars (#2623); the old private names get no entry, as for the other private API. - Changed: the weekly Issue and PR Kinds workflow, beside the milestone workflow's entry (#2626). - The conventions entry records where a context variable lives (#2623), and the role-kind citation rule with its test (#2626). - No entry for #2626's heading and Mermaid fixes, #2564 or fa9af52. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.
1 of 5 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.
make pylint,make mypy,make isort)make testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation only changesDescription of your pull request and other information
Each
:issue:/:pr:role names a number of the right kind, and each ruling made in a PR's review is cited by the issue that PR closes, per #2599. Four headings are renamed or re-cased to match documentation.rst, and the Mermaid labels escape their leading underscores.The test from #1103 checks every role's kind against
tests/project/issue_pr_roles_fixtures/kinds.json. Numbers above the snapshot's maximum are skipped, which is the option the owner chose on #2561.util/issue_pr_kinds.pyregenerates the snapshot. The weeklyIssue and PR Kindsworkflow runs it and opens or updates a bot PR when the snapshot changes. It copies Python Versions' Release App pattern behind thegithub-releaseenvironment, and it never pushesmain.A Sonnet cross-review returned GOOD TO GO, after re-checking each citation against GitHub and the workflow line by line. The Sphinx warning set is identical to
main's.Closes #2561