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 Docs #2

Closed
sVujke opened this issue Jul 1, 2024 · 0 comments · Fixed by #13
Closed

Add Docs #2

sVujke opened this issue Jul 1, 2024 · 0 comments · Fixed by #13
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sVujke
Copy link
Owner

sVujke commented Jul 1, 2024

Create comprehensive documentation for the Python package. This includes:

Installation Guide: Provide step-by-step instructions on how to install the package from PyPI.
Usage Examples: Include code examples demonstrating common use cases and features of the package.
API Reference: Document all public classes, methods, and functions, including parameters, return types, and example usages.

@sVujke sVujke added the documentation Improvements or additions to documentation label Jul 1, 2024
@sVujke sVujke self-assigned this Jul 1, 2024
@sVujke sVujke linked a pull request Aug 2, 2024 that will close this issue
@sVujke sVujke closed this as completed in #13 Aug 2, 2024
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

Successfully merging a pull request may close this issue.

1 participant