You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.The text was updated successfully, but these errors were encountered: