Skip to content

added docs for chain-params.rs (#376) #433

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

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

I added a doc strings to a few pertinent functions inside the chain-params.
Addresses #376

Notes to the reviewers

I refactored docstrings from line comments to better addresses the documentation. Only one function is exposed in the API but I also added docstrings to others.

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-params branch from 4be3103 to e1e7ef1 Compare March 28, 2025 19:28
@lucad70 lucad70 changed the title added docs for function to get dns seeds (#376) added docs for chain-params.rs (#376) Mar 28, 2025
@lucad70 lucad70 force-pushed the docs-chain-params branch from e1e7ef1 to ca8a3a4 Compare April 8, 2025 20:54
@lucad70 lucad70 force-pushed the docs-chain-params branch from e7fc580 to f396ac7 Compare April 11, 2025 17:57
@lucad70
Copy link
Contributor Author

lucad70 commented Apr 11, 2025

I added the suggestions but I am facing a problem with bitcoin_hashes doc. It seems like there is an issue with its documentation, preventing any project using it as dependency to build doc.

@lucad70 lucad70 mentioned this pull request Apr 11, 2025
21 tasks
@jaoleal
Copy link
Contributor

jaoleal commented Apr 11, 2025

I added the suggestions but I am facing a problem with bitcoin_hashes doc. It seems like there is an issue with its documentation, preventing any project using it as dependency to build doc.

just add the flag to ignore dependencies docs

Copy link
Contributor

@jaoleal jaoleal left a comment

Choose a reason for hiding this comment

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

LGMT 98c663f

Copy link
Collaborator

@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 886f360

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