Skip to content

Commit a327a8c

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 202b59f commit a327a8c

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,4 +1,6 @@
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, BC, BCRT, TB};

src/lib.rs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,11 +131,8 @@ extern crate alloc;
131131
extern crate core;
132132

133133
mod error;
134-
/// Re-exports the hrp types from [`primitives::hrp`] to make importing ergonomic for the top level APIs.
135134
pub mod hrp;
136-
/// All the primitive types and functionality used in encoding and decoding.
137135
pub mod primitives;
138-
/// API for encoding and decoding segwit addresses.
139136
pub mod segwit;
140137

141138
#[cfg(all(feature = "alloc", not(feature = "std"), not(test)))]

0 commit comments

Comments
 (0)