Changing docs and examples to use correct function signature #1658
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
Kixunil
previously approved these changes
Feb 21, 2023
bitcoin/src/bip32.rs
Outdated
| @@ -683,7 +683,7 @@ impl ExtendedPubKey { | |||
|
|
|||
| /// Attempts to derive an extended public key from a path. | |||
| /// | |||
| /// The `path` argument can be both of type `DerivationPath` or `Vec<ChildNumber>`. | |||
| /// The `path` argument can be both of type `DerivationPath` or `AsRef<ChildNumber>`. | |||
There was a problem hiding this comment.
"can be of any type implementing AsRef<ChildNumber" would be a bit more natural.
There was a problem hiding this comment.
Fixed in f69363d
Kixunil
added
documentation
trivial
|
Added 0.30 milestone so that the documentation is updated. |
Kixunil
approved these changes
Feb 21, 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.
P: AsRef<[ChildNumber]>means that path can be borrowed as a reference to a slice ofChildNumber.While it does work with
Vec, the documentation and examples mislead the user into thinking that he/she has to use a vec, which is not true. A simple reference to a slice ofChildNumberalso works and does not consume heap