Skip to content

added docs to prunned_utreexo module and its submodules #401

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 11, 2025
Merged

added docs to prunned_utreexo module and its submodules #401

merged 1 commit into from
Mar 11, 2025

Conversation

@lucad70
Copy link
Contributor

@lucad70 lucad70 commented Mar 6, 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

I added missing docs to Floresta Chain crate, prunned utreexo module and its submodules to help on #376 .

Notes to the reviewers

I avoided adding the docs for the structs inside each submodule to make it easier for review.

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)

Images of differences bellow

Screenshot 2025-03-06 at 12 49 36 Screenshot 2025-03-06 at 12 53 25

@Davidson-Souza Davidson-Souza added documentation Improvements or additions to documentation chore Cleaning, refactoring, reducing complexity code quality Generally improves code readability and maintainability labels Mar 6, 2025
JoseSK999
JoseSK999 suggested changes Mar 7, 2025
View reviewed changes
Copy link
Contributor

@JoseSK999 JoseSK999 left a comment

Choose a reason for hiding this comment

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

Thanks for this! A few comments

@lucad70 lucad70 force-pushed the 376-floresta-chain branch from 06ceb78 to 6ba5ba3 Compare March 8, 2025 14:09
JoseSK999
JoseSK999 suggested changes Mar 8, 2025
View reviewed changes
@lucad70 lucad70 force-pushed the 376-floresta-chain branch 2 times, most recently from 87dfa8a to c82587b Compare March 10, 2025 00:01
@lucad70
Copy link
Contributor Author

lucad70 commented Mar 10, 2025

Thanks for the throughout review @JoseSK999 ! I believe I have resolved every request, if there is any other just let me know and I'll fix it right away.

@JoseSK999
Copy link
Contributor

The comment on the chain_state.rs is still unresolved, you copied it on mod.rs instead.

@lucad70
Copy link
Contributor Author

lucad70 commented Mar 10, 2025

My bad. I will pay more attention in the next PRs and I appreciate your patience.

@lucad70 lucad70 force-pushed the 376-floresta-chain branch from c82587b to d8653de Compare March 10, 2025 12:03
@JoseSK999
Copy link
Contributor

No problem! The CI error is unrelated, could you push again to trigger a new CI run?

@lucad70 lucad70 force-pushed the 376-floresta-chain branch from d8653de to 11bc843 Compare March 10, 2025 12:53
JoseSK999
JoseSK999 reviewed Mar 10, 2025
View reviewed changes
Davidson-Souza
Davidson-Souza requested changes Mar 10, 2025
View reviewed changes
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.

Concept ACK.

Just some minor things and we should be ready-to-go.

@lucad70 lucad70 force-pushed the 376-floresta-chain branch from c0cf660 to 11bc843 Compare March 11, 2025 12:17
@lucad70 lucad70 force-pushed the 376-floresta-chain branch from 11bc843 to d4d844f Compare March 11, 2025 16:10
JoseSK999
JoseSK999 approved these changes Mar 11, 2025
View reviewed changes
Copy link
Contributor

@JoseSK999 JoseSK999 left a comment

Choose a reason for hiding this comment

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

ACK

Davidson-Souza
Davidson-Souza approved these changes Mar 11, 2025
View reviewed changes
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 d4d844f

@Davidson-Souza Davidson-Souza merged commit 5eb006c into vinteumorg:master Mar 11, 2025
8 checks passed
@lucad70 lucad70 deleted the 376-floresta-chain branch March 12, 2025 17:20
@lucad70 lucad70 mentioned this pull request Mar 14, 2025
Merged
21 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Davidson-Souza Davidson-Souza Davidson-Souza approved these changes

+1 more reviewer

@JoseSK999 JoseSK999 JoseSK999 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

chore Cleaning, refactoring, reducing complexity code quality Generally improves code readability and maintainability documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@lucad70 @JoseSK999 @Davidson-Souza