Skip to content

Commit

Permalink
chore(bip0039): fix docsrs (#74)
Browse files Browse the repository at this point in the history
* chore(bip0039): fix docsrs

* bump msrv to 1.61.0
  • Loading branch information
koushiro authored Aug 17, 2024
1 parent 1f2e264 commit dd2aa0e
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/bip0039.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ jobs:
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: 1.60.0
toolchain: 1.61.0
override: true

- name: Test
Expand Down
4 changes: 2 additions & 2 deletions bip0039/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ exclude = ["words"]

# docs.rs-specific configuration
[package.metadata.docs.rs]
# RUSTDOCFLAGS="--cfg doc_cfg"
# RUSTDOCFLAGS="--cfg docsrs"
# To build locally: cargo +nightly doc --all-features --no-deps --open
all-features = true
rustdoc-args = ["--cfg", "doc_cfg"]
rustdoc-args = ["--cfg", "docsrs"]

[features]
default = ["std", "rand"]
Expand Down
5 changes: 2 additions & 3 deletions bip0039/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,15 @@
[![gha-svg]][gha-url]
[![crates-svg]][crates-url]
[![docs-svg]][docs-url]
[![msrv-svg]][msrv-url]
![msrv-svg]

[gha-svg]: https://github.com/koushiro/rust-bips/workflows/bip0039/badge.svg
[gha-url]: https://github.com/koushiro/rust-bips/actions
[crates-svg]: https://img.shields.io/crates/v/bip0039
[crates-url]: https://crates.io/crates/bip0039
[docs-svg]: https://docs.rs/bip0039/badge.svg
[docs-url]: https://docs.rs/bip0039
[msrv-svg]: https://img.shields.io/badge/rustc-1.60+-blue.svg
[msrv-url]: https://blog.rust-lang.org/2022/04/07/Rust-1.60.0.html
[msrv-svg]: https://img.shields.io/badge/rustc-1.61+-blue.svg

Another Rust implementation of [BIP-0039](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) standard.

Expand Down
2 changes: 1 addition & 1 deletion bip0039/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ println!("phrase: {}", mnemonic.phrase());
#![deny(unused_imports)]
#![deny(missing_docs)]
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(doc_cfg, feature(doc_cfg))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

#[cfg(not(feature = "std"))]
extern crate alloc;
Expand Down

0 comments on commit dd2aa0e

Please sign in to comment.