docs(release): drop the last cross-refs to the removed alpha subcommand - #557
Open
mocha06 wants to merge 1 commit into
Open
docs(release): drop the last cross-refs to the removed alpha subcommand#557mocha06 wants to merge 1 commit into
mocha06 wants to merge 1 commit into
Conversation
`_apply_prepare`'s stamp note ended with a `(see ``alpha``)` pointer to a subcommand that no longer exists, so the one reference a reader would follow to understand why `stamp=False` exists led nowhere. It now states the reason directly instead of pointing at a symbol. Two more of the same kind that the review did not catch, in `tests/test_release.py`: comments crediting the ahead-of-main guard and the "only one flow cuts alphas" contract to `alpha` rather than `alpha-pr`. Both describe guards that now live in the shared `release_pr` path. `prerelease_track`'s docstring keeps its `alpha` mentions: there it names the PEP 440 track, not the subcommand. Comment-only; no behavior change, so no CHANGELOG entry — the existing Unreleased bullet already describes the shipped contract.
adriannoes
approved these changes
Aug 1, 2026
adriannoes
left a comment
Collaborator
There was a problem hiding this comment.
The leftover from the #556 approval is gone: _apply_prepare's stamp=False note no longer points at a removed alpha subcommand, and the two test comments now credit release_pr / alpha-pr instead of the deleted one-step path. The rewrite states why Unreleased stays intact (beta promotion stamps the whole section) rather than naming a symbol that can rot again.
Checked clean against argparse (prepare, release-pr, alpha-pr, publish, verify), a leftover sweep of scripts/tests/RELEASE, and tests/test_release.py (49 passed). No behavior change, so skipping CHANGELOG is right. PEP 440 track alpha in prerelease_track correctly stays.
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.
Motivation
The non-blocking item from the #556 approval:
_apply_prepare's stamp note ended with a(seealpha)cross-reference to a subcommand that no longer exists. It was the one pointer a reader would follow to understand whystamp=Falseexists, and it led nowhere.Sweeping for the same pattern turned up two more that the review did not catch, both in
tests/test_release.py— comments crediting the ahead-of-main guard and the "only one flow cuts alphas" contract toalpharather thanalpha-pr. Those guards now live in the sharedrelease_prpath.Outcome
No comment, docstring, or doc in the release tooling names a subcommand that argparse does not register. The stamp note states its reason directly rather than pointing at a symbol, which is what made it rot in the first place.
prerelease_track's docstring deliberately keeps itsalphamentions: there the word names the PEP 440 track, not the subcommand.Comment-only, so there is no CHANGELOG entry — no behavior changed, and the existing
## [Unreleased]bullet already describes the shipped contract. Adding one would only put noise in the next alpha's release body, since that body is## [Unreleased].