From: Thibaut Le Guilly <thibaut@cryptogarage.co.jp>
Date: Fri, 13 Jan 2023 11:55:38 +0000 (+0900)
Subject: Document return type of `sign` method.
X-Git-Tag: v0.27.0-rc.1~6^2
X-Git-Url: http://internal-gitweb-vhost/script/%22https:/-sqlite-db-configuration/scripts/struct.CommandStringError.html?a=commitdiff_plain;h=ff720780950e010cb13af7def1d2226841ca3f97;p=bdk

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.
---

diff --git a/src/wallet/mod.rs b/src/wallet/mod.rs
index 6cbaf8a6..5119dafe 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*