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
With #621, our readthedocs doc site will once again contain documentation auto-extracted from the Python code. w00t!
However, our auto-extracted documentation is not that useful, especially in comparison to our API examples, which have been updated much more recently.
we should think about this as we move forward, since it's becoming clear that the Python API for sourmash is super-duper useful.
we also need to fix up our MinHash(...) class documentation, which doesn't get auto-extracted because its an extension module that doesn't get built on readthedocs (although with #616 maybe we can move these docs up to the Signature(...) class.
The text was updated successfully, but these errors were encountered:
I think the docstrings are more useful for being complete discussions of the arguments, while the examples are aimed at people interested in stealing code to use the functions. Different but overlapping audiences.
With #621, our readthedocs doc site will once again contain documentation auto-extracted from the Python code. w00t!
However, our auto-extracted documentation is not that useful, especially in comparison to our API examples, which have been updated much more recently.
we should think about this as we move forward, since it's becoming clear that the Python API for sourmash is super-duper useful.
we also need to fix up our
MinHash(...)
class documentation, which doesn't get auto-extracted because its an extension module that doesn't get built on readthedocs (although with #616 maybe we can move these docs up to theSignature(...)
class.The text was updated successfully, but these errors were encountered: