fix(docs): merge_chains outdated documentation
#1806
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
oleonardolima
force-pushed
the
fix/merge-chains-docs
branch
from
7b166bf to
5efa472
Compare
oleonardolima
force-pushed
the
fix/merge-chains-docs
branch
from
5efa472 to
50b036c
Compare
- it's a small fix for `merge_chains` docs, reported on audit. - adds an `Errors` section to cover what scenarios it can fail.
oleonardolima
force-pushed
the
fix/merge-chains-docs
branch
from
50b036c to
166a8f9
Compare
|
@ValuedMammal Great, thanks for the suggestions! I've rebased the branch and applied the suggestions. |
| @@ -545,31 +545,44 @@ impl std::error::Error for ApplyHeaderError {} | |||
|
|
|||
| /// Applies `update_tip` onto `original_tip`. | |||
| /// | |||
| /// On success, a tuple is returned `(changeset, can_replace)`. If `can_replace` is true, then the | |||
| /// `update_tip` can replace the `original_tip`. | |||
| /// On success, a tuple is returned ([`CheckPoint`], [`ChangeSet`]). | |||
There was a problem hiding this comment.
Suggested change
| /// On success, a tuple is returned ([`CheckPoint`], [`ChangeSet`]). | |
| /// On success, a tuple is returned ([`CheckPoint`], [`ChangeSet`]). A [`CannotConnectError`] occurs when the `original_tip` and `update_tip` chains are disjoint. |
I'd move the rest of the explanation for CannotConnectError to that type's doc.
But I don't want to bike-shed it too much so I'll also ACK this as is and you decide.
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.
Description
It's a minor documentation fix, as reported during the audit and referenced in bitcoindevkit/bdk_wallet#59.
Notes to the reviewers
I'm unsure if anything else / any other explanation should be included in the documentation. Let me know if you think more context should be added to it.
Changelog notice
bdk_chain::local_chain::merge_chainsdocumentation.Checklists
All Submissions:
cargo fmtandcargo clippybefore committing