Skip to content

Commit

Permalink
Document return type of sign method.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Tibo-lg committed Jan 30, 2023
1 parent 2e7a220 commit bf8b0f9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/wallet/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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*
Expand Down

0 comments on commit bf8b0f9

Please sign in to comment.