search

segrelab / cometspy

Python interface for running COMETS simulations and analyzing the results
GNU General Public License v3.0
11 stars 9 forks source link

Make template/set of best practices for writing docstrings #37

Open hgscott opened 1 year ago

hgscott commented 1 year ago

As posted by @hgscott in https://github.com/segrelab/cometspy/issues/30#issuecomment-1684223156: It would be nice to have a template/set of best practices for writing the docstrings to get the best documentation.

We will want to do numpy style docstrings.