As part of the JOSS review (openjournals/joss-reviews#10825), I noticed that the codebase lacks code comments and docstrings — only the main plot2d() function has a brief docstring. Adding docstrings to the major functions and modules would:
- Make the codebase more accessible to potential contributors
- Enable auto-generated API documentation (e.g., via Sphinx autodoc)
- Improve IDE support for users (parameter hints, type information)
This is non-blocking but would significantly improve the project's community-readiness.
As part of the JOSS review (openjournals/joss-reviews#10825), I noticed that the codebase lacks code comments and docstrings — only the main plot2d() function has a brief docstring. Adding docstrings to the major functions and modules would:
This is non-blocking but would significantly improve the project's community-readiness.