Skip to content

Commit a2209d5

Browse files
committed
Remove crate level examples
The API/crate is in the process of being overhauled. Reviewing the crate rustdoc example is a waist of time because it is going to change many times before release - easier to just review actual code and then re-write the crate level rustdoc example before release.
1 parent fdea41f commit a2209d5

File tree

1 file changed

+0
-18
lines changed

1 file changed

+0
-18
lines changed

src/lib.rs

-18
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,6 @@
1111
//!
1212
//! The original description in [BIP-0173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki)
1313
//! has more details. See also [BIP-0350](https://github.com/bitcoin/bips/blob/master/bip-0350.mediawiki).
14-
//!
15-
#![cfg_attr(
16-
feature = "std",
17-
doc = "
18-
# Examples
19-
```
20-
use bech32::{self, FromBase32, ToBase32, Variant, Hrp};
21-
let hrp = Hrp::parse(\"bech32\").expect(\"bech32 is valid\");
22-
let encoded = bech32::encode(hrp, vec![0x00, 0x01, 0x02].to_base32(), Variant::Bech32).unwrap();
23-
assert_eq!(encoded, \"bech321qqqsyrhqy2a\".to_string());
24-
let (hrp, data, variant) = bech32::decode(&encoded).unwrap();
25-
assert_eq!(hrp.to_string(), \"bech32\");
26-
assert_eq!(Vec::<u8>::from_base32(&data).unwrap(), vec![0x00, 0x01, 0x02]);
27-
assert_eq!(variant, Variant::Bech32);
28-
```
29-
"
30-
)]
31-
//!
3214
3315
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
3416
// Experimental features we need.

0 commit comments

Comments
 (0)