Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): merge_chains outdated documentation #1806

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

oleonardolima
Copy link
Contributor

Description

It's a minor documentation fix, as reported during the audit and referenced in #1693.

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

  • Update bdk_chain::local_chain::merge_chains documentation.

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

- it's a small fix for `merge_chains` docs, reported on audit.
@oleonardolima oleonardolima added the documentation Improvements or additions to documentation label Jan 21, 2025
@oleonardolima oleonardolima self-assigned this Jan 21, 2025
/// On success, a tuple is returned `([`CheckPoint`], [`ChangeSet`])`.
///
/// [`CheckPoint`]: bdk_core::CheckPoint
/// [`ChangeSet`]: bdk_chain::local_chain::CheckPoint
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can add a note about how this could fail when the chains don't connect. The test update_local_chain has some examples of this where the error is typically a variation of "two disjoint chains cannot merge".

I see we also propagate the error from apply_changeset_to_checkpoint, but as far as I know we don't have coverage for it (#1576).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants