Skip to content

Add missing documentation #19

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
Open
dssgabriel opened this issue May 13, 2022 · 0 comments
Open

Add missing documentation #19

dssgabriel opened this issue May 13, 2022 · 0 comments
Assignees
@dssgabriel
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@dssgabriel
Copy link
Contributor

Currently, some sections of the Rust code are lacking documentation. It would be nice to make sure that the missing doc comments are added, as well as a complete review of the existing documentation to make sure that it is correct.

We also should add some more info on the environment variables used by the library.
@dssgabriel dssgabriel added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels May 13, 2022
@dssgabriel dssgabriel self-assigned this May 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dssgabriel dssgabriel

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dssgabriel