Skip to content

Commit

Permalink
Fix rendered module docs
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
tcharding committed Jan 12, 2024
1 parent cb2f61e commit d432a4f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
2 changes: 2 additions & 0 deletions src/hrp.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// SPDX-License-Identifier: MIT

//! Re-exports the hrp types from [`primitives::hrp`] to make importing ergonomic for the top level APIs.
#[doc(inline)]
pub use crate::primitives::hrp::{Hrp, BC, BCRT, TB};
3 changes: 0 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,8 @@ extern crate alloc;
extern crate core;

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

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

0 comments on commit d432a4f

Please sign in to comment.