Skip to content

Commit d432a4f

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 cb2f61e commit d432a4f

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
@@ -141,11 +141,8 @@ extern crate alloc;
141141
extern crate core;
142142

143143
mod error;
144-
/// Re-exports the hrp types from [`primitives::hrp`] to make importing ergonomic for the top level APIs.
145144
pub mod hrp;
146-
/// All the primitive types and functionality used in encoding and decoding.
147145
pub mod primitives;
148-
/// API for encoding and decoding segwit addresses.
149146
pub mod segwit;
150147

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

0 commit comments

Comments
 (0)