Skip to content

Conversation

psg-19
Copy link

@psg-19 psg-19 commented Mar 20, 2025

I've submitted a PR to address this issue: #109
Tried documenting some of functions and methods.

@oleonardolima oleonardolima added the documentation Improvements or additions to documentation label Mar 22, 2025
@oleonardolima
Copy link
Collaborator

Thank you for working on this one!

I'd suggest: i) fixing some typos regarding the proper use of Rust's docstrings (i.e.: missing whitespace on /// Start...), checking the rustdoc book for more info see; ii) covering the documentations of more missing items to make the PR more substantial.

@psg-19
Copy link
Author

psg-19 commented Mar 23, 2025

fixed typos and added documentation to more public functions, methods, structs and traits I could find.
Please let me know if anything more needs to be done.

@coveralls
Copy link

coveralls commented Apr 17, 2025

Pull Request Test Coverage Report for Build 14520630096

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage decreased (-0.02%) to 88.149%

Files with Coverage Reduction New Missed Lines %
src/api.rs 1 53.03%
Totals Coverage Status
Change from base Build 13912069194: -0.02%
Covered Lines: 1138
Relevant Lines: 1291

💛 - Coveralls

@oleonardolima
Copy link
Collaborator

You can squash the changes into a single commit, and use the conventional commits terminology, e.g docs: add missing documentation.

Also, there are still some formatting issues, see the CI output, you can run cargo fmt --all --check locally to make sure it's all sound before pushing to remote.

@psg-19 psg-19 force-pushed the adding_documentation branch from e436e40 to 6b2af4c Compare April 17, 2025 16:46
@psg-19
Copy link
Author

psg-19 commented Apr 17, 2025

made the required changes, can you review it once.

@notmandatory notmandatory moved this to Needs Review in BDK Chain Apr 30, 2025
@notmandatory
Copy link
Member

notmandatory commented May 29, 2025

@psg-19 your documentation should follow the recommended format from the docs here:
https://doc.rust-lang.org/stable/rustdoc/how-to-write-documentation.html#documenting-components

In particular start with a concise summary. For these that's all that may be needed. But if more details are needed put those on a following paragraph or lines. It's OK to borrow wording from other projects like rust-bitcoin. For example:
https://docs.rs/bitcoin/latest/bitcoin/struct.TxOut.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Needs Review
Development

Successfully merging this pull request may close these issues.

4 participants