review project documentation

SNEWS2 / SNEWS_Publishing_Tools

Publishing Tool for SNEWS

BSD 3-Clause "New" or "Revised" License

2 stars 2 forks source link

Closed sybenzvi closed 1 year ago

sybenzvi commented 1 year ago

Review snews_pt project documentation, after @KaraMelih's suggestion in the LNGS hackathon coordination doc. Preliminary checklist:

[x] Check top-level READMEs to ensure consistent instructions.
[x] Check readthedocs to make sure installation and usage examples are consistent and useful.
[x] Ensure notebooks and example scripts are properly documented.
[x] Revisit docstrings and make sure they are consistent with module contents.

KaraMelih commented 1 year ago

Mostly addressed in #79 except for the individual docstrings. I can start on that now.