Skip to content
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

Added documentation for some functions and methods. #123

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

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.

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
None yet
Development

Successfully merging this pull request may close these issues.

2 participants