docs: update docs to point to derivation_of_spk
#1361
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
updated docs to point `derivation_of_spk` function to find whether a `KeychainKind` exits for the given `script` fix bitcoindevkit#1042
evanlinjin
requested changes
Mar 1, 2024
Comment on lines
817
to
+819
| /// Return whether or not a `script` is part of this wallet (either internal or external) | ||
| /// Use `derivation_of_spk` function to find the `KeychainKind` for the `script`, or | ||
| /// None if there's no associated `Keychain`. |
There was a problem hiding this comment.
Please follow rust doc conventions. Ref: https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html#documenting-components
We want a separate section for the more detailed description. Also, for clarity, I would reword it like so: "If you wish to find the KeychainKind for the given script, use derivation_of_spk instead."
In addition to this, please have a link for derivation_of_spk.
There was a problem hiding this comment.
Would it make sense to have seperate section telling about the derivation_of_spk in detail and include that point ?
notmandatory
added
documentation
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.
Updated docs of
Wallet.is_mine()function to pointderivation_of_spkfunction to find whether aKeychainKindexits for the givenscriptor not.fix #1042
cargo fmtandcargo clippybefore committing