Skip to content

Conversation

@lucad70
Copy link
Contributor

@lucad70 lucad70 commented Apr 24, 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

This PR aims to add missing docs for submodule proof_util.

It addresses #376

Notes to the reviewers

I have attached screenshots for the differences on the docs but notice I also added comments on private functions.

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)

Was:
Screenshot 2025-04-24 at 17 55 34

Is:
Screenshot 2025-04-24 at 17 59 56

@Davidson-Souza Davidson-Souza added documentation Improvements or additions to documentation code quality Generally improves code readability and maintainability labels Apr 25, 2025
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.

Only nits to make comments more explanatory

@lucad70
Copy link
Contributor Author

lucad70 commented Apr 29, 2025

Thanks for the review! I also added a "`" mark on a few fields as they were throwing warnings during cargo doc execution.

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 e1a9b31

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 e1a9b31

@Davidson-Souza Davidson-Souza merged commit 8955598 into vinteumorg:master Apr 30, 2025
8 checks passed
@lucad70 lucad70 deleted the udata branch July 10, 2025 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code quality Generally improves code readability and maintainability documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants