Skip to content

Commit 928c33f

Browse files
committed
Tweak documentation in BestBlock to be a bit more clear
1 parent a254fcd commit 928c33f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

lightning/src/chain/mod.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,16 @@ pub struct BestBlock {
3838
}
3939

4040
impl BestBlock {
41-
/// Returns the best block from the genesis of the given network.
41+
/// Constructs a `BestBlock` that represents the genesis block at height 0 of the given
42+
/// network.
4243
pub fn from_genesis(network: Network) -> Self {
4344
BestBlock {
4445
block_hash: genesis_block(network).header.block_hash(),
4546
height: 0,
4647
}
4748
}
4849

49-
/// Returns the best block as identified by the given block hash and height.
50+
/// Returns a `BestBlock` as identified by the given block hash and height.
5051
pub fn new(block_hash: BlockHash, height: u32) -> Self {
5152
BestBlock { block_hash, height }
5253
}

0 commit comments

Comments
 (0)