milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Fix erroneous function rustdoc 

The returns part of the function docs appears to be stale, remove it.
Improve wording of rustdocs while we are at it.
This commit is contained in:
Tobin Harding 2022-03-09 12:00:19 +11:00
parent 5464848f45
commit f03092c380
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/blockdata/block.rs
View File

@ -279,8 +279,7 @@ impl Block {
self.txdata.first() self.txdata.first()
} }
/// Get the block height as encoded into the coinbase according to BIP34. /// Returns the block height, as encoded in the coinbase transaction according to BIP34.
/// Returns [None] if not present.
pub fn bip34_block_height(&self) -> Result<u64, Bip34Error> { pub fn bip34_block_height(&self) -> Result<u64, Bip34Error> {
// Citing the spec: // Citing the spec:
// Add height as the first item in the coinbase transaction's scriptSig, // Add height as the first item in the coinbase transaction's scriptSig,