]> Untitled Git - bdk/commitdiff
Document return type of `sign` method.
authorThibaut Le Guilly <thibaut@cryptogarage.co.jp>
Fri, 13 Jan 2023 11:55:38 +0000 (20:55 +0900)
committerTibo-lg <thibaut@cryptogarage.co.jp>
Tue, 31 Jan 2023 01:13:46 +0000 (10:13 +0900)
Small thing but I had to look up the code to see what the returned boolean was about, thought it might be good to have in the docs.

src/wallet/mod.rs

index 6cbaf8a60e1f683a34439b9dcfdc6fbe3f715e18..5119dafef8a3d614077cd3265b5efcc35aa6a56f 100644 (file)
@@ -1084,7 +1084,7 @@ where
     }
 
     /// Sign a transaction with all the wallet's signers, in the order specified by every signer's
-    /// [`SignerOrdering`]
+    /// [`SignerOrdering`]. This function returns the `Result` type with an encapsulated `bool` that has the value true if the PSBT was finalized, or false otherwise.
     ///
     /// The [`SignOptions`] can be used to tweak the behavior of the software signers, and the way
     /// the transaction is finalized at the end. Note that it can't be guaranteed that *every*