Skip to content

Commit

Permalink
doc: add module-level docs
Browse files Browse the repository at this point in the history
fixes CI.
  • Loading branch information
storopoli committed Sep 13, 2024
1 parent af506e2 commit 51dabce
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/hex.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! A module for encoding and decoding hexadecimal strings.

use crate::err;
use terrors::OneOf;

Expand Down
2 changes: 2 additions & 0 deletions src/macros.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! Macros for error handling.

#[macro_export]
macro_rules! err {
($item:expr) => {{
Expand Down
3 changes: 3 additions & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
//! A simple faucet server that uses [`axum`] and [`bdk_wallet`]
//! to generate and dispense bitcoin.

pub mod hex;
pub mod macros;

Expand Down

0 comments on commit 51dabce

Please sign in to comment.