Skip to content

docs(electrum): fix stale MSRV in README - #2330

Open
artofbitcoin wants to merge 1 commit into
bitcoindevkit:masterfrom
artofbitcoin:docs/electrum-readme-msrv
Open

artofbitcoin wants to merge 1 commit into
bitcoindevkit:masterfrom
artofbitcoin:docs/electrum-readme-msrv

Conversation

@artofbitcoin

Copy link
Copy Markdown

Description

crates/electrum/README.md (also the crate page on crates.io) still documents the old MSRV:

  • It says "This crate has a MSRV of 1.75.0", but crates/electrum/Cargo.toml has rust-version = "1.85.0" since the MSRV bump in 8c15308 (chore(msrv): bump MSRV to 1.85.0 #2055), which updated the root README but not this file.
  • Its only pinning instruction, cargo update -p home --precise "0.5.9", no longer works: home is not in the dependency tree anymore, so cargo fails with error: package ID specification 'home' did not match any packages.

This updates the MSRV to 1.85.0 and points to ci/pin-msrv.sh, the same way the root README does.

Notes to the reviewers

The link to pin-msrv.sh is absolute on purpose: the README is the crate's readme on crates.io, where a relative ../../ci/pin-msrv.sh link would be broken.

Changelog notice

None (docs only).

Checklists

All Submissions:

The README still said 1.75.0 and told users to run
`cargo update -p home --precise "0.5.9"`, but the crate's rust-version is
1.85.0 since the MSRV bump (8c15308) and `home` is no longer in the
dependency tree, so that command fails. Point to ci/pin-msrv.sh like the
root README does. The link is absolute so it also works on crates.io.

Co-authored-by: Claude <noreply@anthropic.com>

@noahjoeris noahjoeris left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for spotting!
I think it's better to drop it than to update it. It's an unnecessary maintenance burden.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants