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.

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

Improve documentation #1

Open
matteocao opened this issue Nov 25, 2024 · 0 comments
Open

Improve documentation #1

matteocao opened this issue Nov 25, 2024 · 0 comments
Assignees
@rocheze
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@matteocao
Copy link
Contributor

Is your feature request related to a problem? Please describe.
The readme is lacking some basic info on how to install and use the repo with minimal examples
Also, many docstrings missing

Describe the solution you'd like
A better readme
Put a docstring in each function. Also, make sure you are consistent with the sphinx_rtd_theme formatting

Describe alternatives you've considered
NA

Additional context
NA
@matteocao matteocao added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rocheze rocheze

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rocheze @matteocao