Document return type of sign method.
#834
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
w0xlt
reviewed
Jan 24, 2023
src/wallet/mod.rs
Outdated
| @@ -1084,7 +1084,7 @@ where | |||
| } | |||
|
|
|||
| /// Sign a transaction with all the wallet's signers, in the order specified by every signer's | |||
| /// [`SignerOrdering`] | |||
| /// [`SignerOrdering`]. Returns true if the PSBT was finalized, and false otherwise. | |||
There was a problem hiding this comment.
nit: This function returns the Result type with an encapsulated bool that has the value true if the PSBT was finalized, or false otherwise.
|
This looks good, but it needs a rebase since we changed our CI MSRV. |
|
Rebased on master but someone needs to approve the CI run. |
|
Thanks @Tibo-lg for the rebase, but I also see that your commit needs to be signed. Can you setup your git signing and rebase your commit again to get it signed? |
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.
Done! |
w0xlt
approved these changes
Jan 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Description
Documents the meaning of the returned value on the wallet
signmethod.I've just edited from github so skipped all the checks if that's not ok maybe someone else can update it properly.