Skip to content

Commit a9b611b

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 2b3f42f commit a9b611b

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

142142
mod error;
143-
/// Re-exports the hrp types from [`primitives::hrp`] to make importing ergonomic for the top level APIs.
144143
pub mod hrp;
145-
/// All the primitive types and functionality used in encoding and decoding.
146144
pub mod primitives;
147-
/// API for encoding and decoding segwit addresses.
148145
pub mod segwit;
149146

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

0 commit comments

Comments
 (0)