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
Expand the description of the package purpose in README. Or point to the intro in the Documentation
Fix the broken link to the “usage section” of the Installation page in the documentation
The notebooks for the usage examples can be more verbose. Many sections have only the title.
Add API Reference (e.g. auto-generated with sphinx-autoapi)
Do not forget to put the JOSS paper reference (once published) in README e.g. simply via badge.
Ensure uniformity of in-code comment strings (a very nice example is e.g. write_tsdf.py)
Write a blog post about the package
Improve the RSD page, e.g. “what the package can do for you” is better eye-catches, than simply the README (especially with limited purpose description). Also “how to cite” as a prominent section. Add testimonials from the project partners. Don’t forget the JOSS paper once published.
The text was updated successfully, but these errors were encountered:
Feature Description
The documentation and
The text was updated successfully, but these errors were encountered: