Repository navigation
docs(ci): cite python-versions.toml keys and recorded defects by name (#2165) - #2199
Merged
Merged
Conversation
…#2165) Problem: three anchors used file:line, which the anchor-by-name rule forbids: the updater wrote `.github/python-versions.toml:N` into the workflows page, the recorded-defect contract asked for "the file:line that causes it", and the workflows page cited actions/runner's `StepsRunner.cs:205-208`. Fix (parts 1-3): - util/update_python_versions.py writes and checks the `"3.11"` keys; `lines_of` and the `tier_lines` fact go. workflows.rst regenerated. - The defect field docs, failure messages and test-coverage.rst ask for the function, class or method that causes it. No entry used file:line. - workflows.rst cites `StepsRunner.RunAsync`, still at `796cc18ff`. Test: test_the_workflows_page_cites_each_version_by_its_key (renamed from ..._on_its_line) and TestTheDocsSayIt pin the names; both fail on main's workflows.rst.
JarryShaw
added
docs
Owner
Author
|
Review: GOOD TO GO at |
JarryShaw
added
review: good-to-go
5 tasks done
Owner
Author
|
Ready to merge at
|
JarryShaw
removed
the
review: good-to-go
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 testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription
Closes #2165, per the owner's ruling that tooling-generated anchors are cited by name too.
util/update_python_versions.pywrites and checksworkflows.rst's compat rows and two span sentences by version key (key"3.11"of.github/python-versions.toml,keys"3.11"to"3.15"``) instead ofpython-versions.toml:N. `lines_of`, the `tier_lines` fact and `make_facts`'s `tier_file` argument are removed. `workflows.rst` regenerates byte for byte.defect/reasonfield docs and failure messages intest_option_roundtrip_unit.py, the_roundtrip.py/_edge_roundtrip.pyharnesses,test_dispatch_registry_unit.pyandtest-coverage.rst. None of the 16 existing values used afile:line.workflows.rstcites actions/runner'sStepsRunner.RunAsyncat796cc18ff, notStepsRunner.cs:205-208. Its sibling:322-353is renamed by docs(docs): fifth whole-repo pass over the non-API docs, with issue/PR roles (#1103) #2161.test_the_workflows_page_cites_each_version_by_its_key, renamed from…_on_its_line, rejects anypython-versions.toml:\dand checks every key and span.TestTheDocsSayItpins the method name.main'sworkflows.rst.tests/projectfiles that read these files plus the tier guard pass (964), as do the round-trip and dispatch suites with the docstring contract (239).