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

Are there docs for this project somewhere? #56

Open
AndKaminer opened this issue Dec 15, 2023 · 2 comments
Open

Are there docs for this project somewhere? #56

AndKaminer opened this issue Dec 15, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@AndKaminer
Copy link
Contributor

Hi all. I was wondering if there is API documentation for the project somewhere. If there isn't, I'd be happy to write some up. I'm on winter break, so I have nothing better to do.
@MarcCote
Copy link
Collaborator

We don't have proper documentation other than the README.md. If you want to give it a go, that would be very useful for the community. :)

@MarcCote
Copy link
Collaborator

A first step could be to improve the number and quality of __docstring__ in the code.

@MarcCote MarcCote added the documentation Improvements or additions to documentation label Dec 18, 2023
MarcCote added a commit that referenced this issue Jan 25, 2024
@MarcCote
Merge pull request #66 from AndKaminer/main
35a9500 
Add docstrings #56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@MarcCote @AndKaminer