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

improve Documentation #62

Open
Deric-W opened this issue Jan 9, 2022 · 0 comments
Open

improve Documentation #62

Deric-W opened this issue Jan 9, 2022 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@Deric-W
Copy link
Owner

Deric-W commented Jan 9, 2022

Problem:
The current documentation consists of the README and docstrings, which contain only limited amounts of information.
Furthermore, it is laborious to look in the source code for documentation.

Solution:
Use documentation generators like Sphinx to generate documentation from docstrings and annotations and host them on Read the Docs.

Further ideas:
All classes should have a custom __repr__ method to improve interactive debugging.

@Deric-W Deric-W added the enhancement New feature or request label Jan 9, 2022
@Deric-W Deric-W self-assigned this Jan 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant