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

improve documention #134

Open
JB-Wolf opened this issue May 23, 2024 · 0 comments · May be fixed by #140
Open

improve documention #134

JB-Wolf opened this issue May 23, 2024 · 0 comments · May be fixed by #140
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@JB-Wolf
Copy link
Collaborator

JB-Wolf commented May 23, 2024

The overall project and individual functions need better docstrings.
Also, where applicable, granular comments should improve understandability and readability.

@JB-Wolf JB-Wolf added the documentation Improvements or additions to documentation label May 23, 2024
@samuelvitorsaraiva samuelvitorsaraiva linked a pull request Jul 24, 2024 that will close this issue
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 a pull request may close this issue.

2 participants