8000 Remove stale MSRV docs by tcharding · Pull Request #1126 · rust-bitcoin/rust-bitcoin · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Remove stale MSRV docs #1126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 26, 2022
Merged

Conversation

tcharding
Copy link
Member
@tcharding tcharding commented Jul 26, 2022

We have stale docs referring to the old MSRV. We do not need MSRV docs
in CONTRIBUTING because we have them in the README already.

Fix stale docs by doing:

  • Remove the MSRV docs from readme in favour of CONTRIBUTING.md.
  • Add a sentence to the redame pointing readers towards CONTRIBUTING.md.
  • Point readers towards RUSTUP_TOOLCHAIN

We have stale docs referring to the old MSRV. We do not need MSRV docs
in `CONTRIBUTING` because we have them in the README already.

Fix stale docs by doing:
- Remove the MSRV docs from readme in favour of `CONTRIBUTING.md`.
- Add a sentence to the redame pointing readers towards `CONTRIBUTING.md`.
We have docs that use an env var `BITCOIN_MSRV` that no longer exists.
Point readers towards `RUSTUP_TOOLCHAIN`.

(Note that we still use `TOOLCHAIN` in the script but it is being phased
out, `RUSTUP_TOOLCHAIN` works today.)
Copy link
Member
@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

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

ACK fe840f0

Copy link
Collaborator
@Kixunil Kixunil left a comment

Choose a reason for hiding this comment

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

ACK fe840f0

@apoelstra apoelstra merged commit 7a34697 into rust-bitcoin:master Jul 26, 2022
@tcharding tcharding deleted the 07-26-msrv-doc branch July 27, 2022 00:54
ChallengeDev210 pushed a commit to ChallengeDev210/rust-bitcoin that referenced this pull request Aug 1, 2022
fe840f0 Fix stale toolchain docs (Tobin C. Harding)
73b506e Remove stale MSRV docs (Tobin C. Harding)

Pull request description:

  We have stale docs referring to the old MSRV. We do not need MSRV docs
  in `CONTRIBUTING` because we have them in the README already.

  Fix stale docs by doing:
  - Remove the MSRV docs from readme in favour of `CONTRIBUTING.md`.
  - Add a sentence to the redame pointing readers towards `CONTRIBUTING.md`.
  - Point readers towards `RUSTUP_TOOLCHAIN`

ACKs for top commit:
  apoelstra:
    ACK fe840f0
  Kixunil:
    ACK fe840f0

Tree-SHA512: 6d3006db7a460e5d7146b73ff4b99dc322d396e65da39f5ea47c4904aa387c8a36e4a8ae707653dbab90096e692bf69918e6c19c4d3d989c85b22dba4dcba904
@Kixunil Kixunil added this to the 0.29.0 milestone Aug 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development 39C2

Successfully merging this pull request may close these issues.

3 participants
0