search

biocore / microsetta-private-api

A private microservice to support The Microsetta Initiative
BSD 3-Clause "New" or "Revised" License
6 stars 19 forks source link

Docstrings #8

Open wasade opened 4 years ago

wasade commented 4 years ago

Many classes methods are missing formal docstrings. Because of codebase flux, I'm not sure if it would make sense to list all the blocks missing documentation here at this time. This issue can be closed once we have at least minimal (ideally comprehensive) docstrings on all methods and classes.

dhakim87 commented 4 years ago

Note: Ensure consistency with NumpyDoc standard

dhakim87 commented 4 years ago

See this document on code standards for the Knight Lab: https://docs.google.com/document/d/1bb9YmdnYTVJo6zcswCw2gDvowyALIirDWqNva6NsPC0. For Python code in particular, we generally recommend the scikit-bio coding standards: see http://scikit-bio.org/docs/latest/development/coding_guidelines.html.