+
Skip to content

Docs chain state builder #430

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

Merged
merged 3 commits into from
Apr 14, 2025

Conversation

lucad70
Copy link
Contributor

@lucad70 lucad70 commented Mar 28, 2025

What is the purpose of this pull request?

  • Bug fix
  • Documentation update
  • New feature
  • Test
  • Other:

Which crates are being modified?

  • floresta-chain
  • floresta-cli
  • floresta-common
  • floresta-compact-filters
  • floresta-electrum
  • floresta-watch-only
  • floresta-wire
  • floresta
  • florestad
  • Other:

Description

Added missing docs for the Floresta Chain, specifically the Chain State Builder.

Notes to the reviewers

Most of the struct, the enum and the methods are self explaining. I added docs to keep it nice on cargo doc. Addresses #376

Checklist

  • I've signed all my commits
  • I ran just lint
  • I ran cargo test
  • I've checked the integration tests
  • I've followed the contribution guidelines
  • I'm linking the issue being fixed by this PR (if any)

@lucad70 lucad70 force-pushed the docs-chain-state-builder branch from bf12cc1 to 1b154bb Compare March 28, 2025 18:36
@jaoleal
Copy link
Contributor

jaoleal commented Mar 31, 2025

ack 1b154bb

@lucad70 lucad70 force-pushed the docs-chain-state-builder branch from 1b154bb to 709420a Compare April 11, 2025 18:11
@lucad70
Copy link
Contributor Author

lucad70 commented Apr 11, 2025

I believe I addressed each suggestion. If I missed anything just let me know. As #433 , this is also being prevented to build doc as the bitcoin_hashes dependency is failing to build docs.

@Davidson-Souza
Copy link
Member

As #433 , this is also being prevented to build doc as the bitcoin_hashes dependency is failing to build docs.

Oh, shoot! rustc is panic-ing while trying to build docs for this crate. Is that new?

(We should run cargo docs on our CI too 🤔)

@lucad70
Copy link
Contributor Author

lucad70 commented Apr 11, 2025

As #433 , this is also being prevented to build doc as the bitcoin_hashes dependency is failing to build docs.

Oh, shoot! rustc is panic-ing while trying to build docs for this crate. Is that new?

(We should run cargo docs on our CI too 🤔)

Well, it was working about 10 days ago as I was able to create the docs. I ran cargo doc --open without an issue on Rust-Bitcoin. I am checking now to see whats really going on.

@lucad70
Copy link
Contributor Author

lucad70 commented Apr 11, 2025

This is the log am I getting:

query stack during panic:
 Documenting futures-executor v0.3.31
#0 [doc_link_resolutions] resolutions for documentation links for a module
end of query stack
error: could not document `bitcoin_hashes`

I know @luisschwab also got this same error, is anyone else getting it when running cargo doc --open?

Copy link
Member

@Davidson-Souza Davidson-Souza left a comment

Choose a reason for hiding this comment

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

ACK 709420a

The error seems unrelated, I'm having the exact same problem with master

@jaoleal
Copy link
Contributor

jaoleal commented Apr 14, 2025

This is the log am I getting:

query stack during panic:
 Documenting futures-executor v0.3.31
#0 [doc_link_resolutions] resolutions for documentation links for a module
end of query stack
error: could not document `bitcoin_hashes`

I know @luisschwab also got this same error, is anyone else getting it when running cargo doc --open?

I was... maybe we could raise this for the bitcoin_hashes folks ?

@Davidson-Souza Davidson-Souza merged commit 77251db into vinteumorg:master Apr 14, 2025
8 checks passed
@lucad70
Copy link
Contributor Author

lucad70 commented Apr 14, 2025

This is the log am I getting:

query stack during panic:

Documenting futures-executor v0.3.31

#0 [doc_link_resolutions] resolutions for documentation links for a module

end of query stack

error: could not document bitcoin_hashes

I know @luisschwab also got this same error, is anyone else getting it when running cargo doc --open?

I was... maybe we could raise this for the bitcoin_hashes folks ?

I tried to build the Bitcoin Rust docs to see if anything would happen. It didn't. It appears to be a problem when it's on dependencies.

@lucad70 lucad70 deleted the docs-chain-state-builder branch April 24, 2025 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载