From ff720780950e010cb13af7def1d2226841ca3f97 Mon Sep 17 00:00:00 2001 From: Thibaut Le Guilly Date: Fri, 13 Jan 2023 20:55:38 +0900 Subject: [PATCH] Document return type of `sign` method. 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 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/wallet/mod.rs b/src/wallet/mod.rs index 6cbaf8a60..5119dafef 100644 --- a/src/wallet/mod.rs +++ b/src/wallet/mod.rs @@ -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*