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

JOSS review, docstrings #72

Closed
alexsquires opened this issue Apr 25, 2023 · 2 comments · Fixed by #75
Closed

JOSS review, docstrings #72

alexsquires opened this issue Apr 25, 2023 · 2 comments · Fixed by #75

Comments

@alexsquires
Copy link

With regards to the review point:

Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?

Generally speaking, the level of documentation is good, I just had a couple of points I wanted to clarify.

  1. Is there a reason why some functions are given docstrings, and some are not? e.g in taufactor.metrics, triple_phase_boundary has no docstring, but the others do.
  2. As you are using sphinx+readthedocs to generate your documentation, would it be possible to generate module-level documentation on the readthedocs site? (Though this is more "nice-to-have")
@isaacsquires
Copy link
Member

Thank you for raising this. We have added dosctrings for the missing modules and created API reference for the modules in the docs. This should be resolved by #75

@isaacsquires isaacsquires linked a pull request May 5, 2023 that will close this issue
@alexsquires
Copy link
Author

Great, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants