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. #169

Open
gbbr opened this issue May 15, 2023 · 2 comments
Open

Add documentation. #169

gbbr opened this issue May 15, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@gbbr
Copy link
Member

gbbr commented May 15, 2023

We need to add more documentation, both to the API, and to the package as a whole, especially the examples. It is unclear what each example is, how to use it, and what it represents.

@tigrannajaryan tigrannajaryan added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jun 16, 2023
@Psychodahlia
Copy link

Hi @gbbr if you still need help documenting the APIs, I would be happy to help. I took some Udemy courses on API documentation, and I'm looking for some hands on experience.

@hamzmu
Copy link

hamzmu commented Jan 10, 2024

@gbbr is this issue still open?

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 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants