Improve docs in sighash and psbt/mod.rs
#956
Merged
Conversation
This file contains hidden or 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
apoelstra
previously approved these changes
Apr 20, 2022
|
Converting to draft while we do the MSRV release. |
Improve the rustdoc documentation in the `sighash` module by doing: - Improve grammar - Use full sentences (full stops and capitalisation) - Use 100 line column width - Use back ticks and links as appropriate - Improve correctness of `SigHashCache::new` function
Improve documentation in `psbt/mod.rs` by doing: - Use full sentences (full stops and capitalisation) - Use 100 line column width - Use back ticks and links as appropriate - Use `Errors` section - Use third person tense to describe functions
52ec1cc to
9896f27
Compare
|
Rebased after the edition 2018 shenanigans. |
apoelstra
approved these changes
May 19, 2022
sanket1729
reviewed
May 20, 2022
| /// | ||
| /// # Errors | ||
| /// | ||
| /// If transactions is not unsigned. | ||
| pub fn from_unsigned_tx(tx: Transaction) -> Result<Self, Error> { |
There was a problem hiding this comment.
Aside. As noted elsewhere, If we are consuming a value, we should return it in the Error. Perhaps a good first issue
ChallengeDev210
pushed a commit
to ChallengeDev210/rust-bitcoin
that referenced
this pull request
Aug 1, 2022
…sbt/mod.rs` 9896f27 psbt: Improve documentation (Tobin C. Harding) 33a5083 sighash: Improve documentation (Tobin Harding) Pull request description: Done while working on sighash and PSBT signing. Just the usual docs fixes. Note, does not do the whole `psbt` module just the file mentioned. ACKs for top commit: apoelstra: ACK 9896f27 Tree-SHA512: 5fbfa258cdb216189922a49a42b7ab9fb78faeee72d82f8cb99a1b3d930d170074013e317b0e7af259a404ac4db93841b4d2b525e933c5e145da71e7522800fd
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 sin
2EF4
gle 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.
Done while working on sighash and PSBT signing. Just the usual docs fixes. Note, does not do the whole
psbtmodule just the file mentioned.