Skip to content

Added simple docs to structs and enums of error #447

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 3 commits into from
Apr 23, 2025
Merged

Added simple docs to structs and enums of error #447

merged 3 commits into from
Apr 23, 2025

Conversation

@lucad70
Copy link
Contributor

@lucad70 lucad70 commented Apr 17, 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 descriptions of enums and structs regarding errors on floresta_chain.
Addresses #376

Notes to the reviewers

I opted to not included comments for each field as each field is already self explaining.

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)

@Davidson-Souza Davidson-Souza added documentation Improvements or additions to documentation chore Cleaning, refactoring, reducing complexity labels Apr 17, 2025
JoseSK999
JoseSK999 suggested changes Apr 18, 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.

Concept ACK

Davidson-Souza
Davidson-Souza approved these changes Apr 23, 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 a4cfc75

JoseSK999
JoseSK999 approved these changes Apr 23, 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 a4cfc75

@Davidson-Souza Davidson-Souza merged commit 6be5e9d into vinteumorg:master Apr 23, 2025
8 checks passed
@lucad70 lucad70 deleted the docs_error branch April 24, 2025 20:03
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 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 @Davidson-Souza @JoseSK999