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

Merge rust-bitcoin/rust-bitcoin#2776: Fix rustdoc header format 

6d0d0fe51f Fix rustdoc header format (jamil.lambert)

Pull request description:

  By convention rustdoc headers should not include a colon.

  Removed colon from rustdoc headers.

ACKs for top commit:
  apoelstra:
    ACK 6d0d0fe51f

Tree-SHA512: 36d5822e80cc86139ce07a1c86681998e1d27549421b9b50589fe4a9a5c860ed47f145d5af9501957f199d0f77df069c2b295d43ed4a15e9b6d98c0edc12abd0
This commit is contained in:
Andrew Poelstra 2024-05-16 17:48:53 +00:00
parent 2fe579bd3f 6d0d0fe51f
commit 47527abd53
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
bitcoin/src/taproot/mod.rs
View File

@ -388,12 +388,12 @@ impl TaprootBuilder {
/// example, [(3, S1), (2, S2), (5, S3)] would construct a [`TapTree`] that has optimal /// example, [(3, S1), (2, S2), (5, S3)] would construct a [`TapTree`] that has optimal
/// satisfaction weight when probability for S1 is 30%, S2 is 20% and S3 is 50%. /// satisfaction weight when probability for S1 is 30%, S2 is 20% and S3 is 50%.
/// ///
/// # Errors: /// # Errors
/// ///
/// - When the optimal Huffman Tree has a depth more than 128. /// - When the optimal Huffman Tree has a depth more than 128.
/// - If the provided list of script weights is empty. /// - If the provided list of script weights is empty.
/// ///
/// # Edge Cases: /// # Edge Cases
/// ///
/// If the script weight calculations overflow, a sub-optimal tree may be generated. This should /// If the script weight calculations overflow, a sub-optimal tree may be generated. This should
/// not happen unless you are dealing with billions of branches with weights close to 2^32. /// not happen unless you are dealing with billions of branches with weights close to 2^32.
@ -466,7 +466,7 @@ impl TaprootBuilder {
/// Converts the builder into a [`NodeInfo`] if the builder is a full tree with possibly /// Converts the builder into a [`NodeInfo`] if the builder is a full tree with possibly
/// hidden nodes /// hidden nodes
/// ///
/// # Errors: /// # Errors
/// ///
/// [`IncompleteBuilderError::NotFinalized`] if the builder is not finalized. The builder /// [`IncompleteBuilderError::NotFinalized`] if the builder is not finalized. The builder
/// can be restored by calling [`IncompleteBuilderError::into_builder`] /// can be restored by calling [`IncompleteBuilderError::into_builder`]