Repository navigation
docs: state current behaviour where text pins held change-relative wording (#2228) - #2242
Merged
Merged
Conversation
…rding (#2228) Problem: four tests pinned sentences that narrate a change ("#808 dropped TransportProtocol's IntFlag base", "value were both the bytes object", the compat.cached_property "backport", "passed before the change too"), so the prose could not be made timeless without the pin. Fix: reword each to state current behaviour -- TransportProtocol is an IntEnum, not an IntFlag; no Method member has a bytes name or value; compat.cached_property re-exports functools.cached_property; the unknown-role guard names only :ref: -- mirroring vendor templates into the const modules by hand, and move each pin onto the new wording. Test: the updated pins fail on origin/main and pass here; reverting either role to a literal fails ConvertedReferenceTests.
JarryShaw
added
docs
Owner
Author
|
Review: GOOD TO GO at
|
JarryShaw
added
review: good-to-go
Contributor
|
Coverage: 91.56% (unit tier, Python 3.15,
Per-file detail: the |
Owner
Author
|
Ready to merge at
|
5 tasks done
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
Part of #2228: four of its five pins. The
releasing.rstline citation and itsBARE_ELSEWHEREentry come with #2231's PR. Each rewrite states current behaviour, and its pin moves with it.test_docs_internal_refs_1947_unitCONVERTED_dispatchdocstring saysTransportProtocolis anIntEnum, not anIntFlag(#808), in vendor and consttest_const_method_value_lookup_908_unitMethod.get: "no member of this registry has abytesname or value", in source and templateRaises:documents thebytesValueErrortest_docs_internal_refs_1940_unitCONVERTEDsentinel-convention.rst:compat.cached_propertyis a re-export offunctools.cached_property(#2051)test_issue_refs_in_commentsMETA_MENTIONStest_changelog_md's comment states what the unknown-role guard refuses{NAME}substitution, and the vendor-parity test passes.origin/main, the new pins give 5 failed. Turning a role back into a literal fails bothCONVERTEDtests.test_changelog_mdgive 101 passed.tests/vendorandtests/constgive 534 passed.test_docs_*and the docstring contract give 75 passed.