Skip to content

Commit 739ab3b

Browse files
committed
blossom: add module-level documentation for all source files
Signed-off-by: Yuki Kishimoto <[email protected]>
1 parent eff00fc commit 739ab3b

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed

crates/nostr-blossom/src/bud01.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Implements data structures specific to BUD-01
2+
13
use std::fmt;
24

35
use nostr::hashes::sha256::Hash as Sha256Hash;

crates/nostr-blossom/src/bud02.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Implements data structures specific to BUD-02
2+
13
use nostr::hashes::sha256::Hash as Sha256Hash;
24
use nostr::{Timestamp, Url};
35
use serde::{Deserialize, Serialize};

crates/nostr-blossom/src/client.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Implements a Blossom client for interacting with Blossom servers
2+
13
use std::error::Error;
24
use std::time::Duration;
35

crates/nostr-blossom/src/lib.rs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@
1414
#![warn(rustdoc::bare_urls)]
1515
#![warn(clippy::large_futures)]
1616

17-
/// Implements data structures specific to BUD-01
1817
pub mod bud01;
19-
/// Implements data structures specific to BUD-02
2018
pub mod bud02;
21-
/// Implements a Blossom client for interacting with Blossom servers
2219
pub mod client;

0 commit comments

Comments
 (0)