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
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.
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.
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")
The text was updated successfully, but these errors were encountered:
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
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.
taufactor.metrics
,triple_phase_boundary
has no docstring, but the others do.The text was updated successfully, but these errors were encountered: