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

Lack of documentation, examples #6

Open
zoedsoupe opened this issue Jan 16, 2025 · 0 comments
Open

Lack of documentation, examples #6

zoedsoupe opened this issue Jan 16, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@zoedsoupe
Copy link
Collaborator

Improve documentation

Link

N/A

Describe the problem

There're a bunch of internal flows, logic, functions, structs and other parts of the library that lacks explicit and descriptive documentation.

Describe the improvement

Well, write more documentation, doctests and simple and concise examples for each function that composes the public API

Additional context

N/A

@zoedsoupe zoedsoupe added the documentation Improvements or additions to documentation label Jan 16, 2025
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

No branches or pull requests

1 participant