Skip to content

Commit 6e2be27

Browse files
committed
Fix rendered module docs
Currently we have docs for public modules in two places and these are joined together when rendered as HTML. Remove the rustdoc strings from `lib.rs` and defer to the modules for the module level docs.
1 parent f982bb9 commit 6e2be27

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

src/hrp.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
// SPDX-License-Identifier: MIT
22

3+
//! Re-exports the hrp types from [`primitives::hrp`] to make importing ergonomic for the top level APIs.
4+
35
#[doc(inline)]
46
pub use crate::primitives::hrp::Hrp;
57
#[doc(inline)]

src/lib.rs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,8 @@ pub use crate::primitives::iter::{ByteIterExt, Fe32IterExt};
153153
pub use crate::primitives::{Bech32, Bech32m, NoChecksum};
154154

155155
mod error;
156-
/// Re-exports the hrp types from [`primitives::hrp`] to make importing ergonomic for the top level APIs.
157156
pub mod hrp;
158-
/// All the primitive types and functionality used in encoding and decoding.
159157
pub mod primitives;
160-
/// API for encoding and decoding segwit addresses.
161158
pub mod segwit;
162159

163160
/// Decodes a bech32 encoded string.

0 commit comments

Comments
 (0)