docs: bring the rustc badge up to the workspace MSRV - #2458
Draft
mehmetkr-31 wants to merge 1 commit into
Draft
Conversation
The README badge advertised `rustc-1.93+` while `rust-toolchain.toml` pins channel `1.96` and the workspace `Cargo.toml` sets `rust-version = "1.96.1"`. A contributor following the badge installs a toolchain the workspace rejects, and only finds out when cargo refuses to build. Uses 1.96.1 rather than 1.96, since `rust-version` is what cargo actually enforces. Swept the rest of the repo's markdown, TOML and workflow files for other references to 1.93/1.94/1.95; this badge was the only one. Closes 0xMiden#2456
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
1 participant
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.
Closes #2456
Draft while I wait to be assigned on the issue.
Rationale
The README badge advertised
rustc-1.93+, while the workspace pins higher:rust-toolchain.toml→ channel1.96Cargo.toml→rust-version = "1.96.1"A contributor who follows the badge installs a toolchain the workspace rejects, and only finds out when cargo refuses to build.
Changes
One line. The badge now reads
rustc-1.96.1+.I used
1.96.1rather than1.96becauserust-versionis what cargo actually enforces — therust-toolchain.tomlchannel is the looser of the two, so quoting it would under-state the requirement by a patch version.Test plan
There is nothing to execute here, so instead: I swept the repo's markdown, TOML and workflow files for other references to
1.93,1.94and1.95, in case the badge had company. It did not — this was the only stale mention.Docs only, so this wants the
no changeloglabel.