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

add documentation #16

Open
pavelnikonorov opened this issue Jul 4, 2024 · 2 comments
Open

add documentation #16

pavelnikonorov opened this issue Jul 4, 2024 · 2 comments

Comments

@pavelnikonorov
Copy link
Collaborator

Something to generate API docs from. It's very hard to read the code otherwise. Besides, we can use it to define doctests, as I understand.

Originally posted by @uniqueg in #13 (review)

@aaravm
Copy link
Collaborator

aaravm commented Jul 5, 2024

While adding documentation in the code, I figure we could also address this along with it: #13 (comment)

@uniqueg
Copy link
Member

uniqueg commented Jul 25, 2024

I also agree that providing documentation should be done continuously, with every proposed code change (as well as tests).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants