RasmussenLab / MOVE

MOVE (Multi-Omics Variational autoEncoder) for integrating multi-omics data and identifying cross modal associations
https://move-dl.readthedocs.io/
MIT License
64 stars 25 forks source link

🎨 Format docstrings #31

Closed ri-heme closed 1 year ago

ri-heme commented 2 years ago

For compatibility with Sphinx (and better annotation), we will format the docstrings according to Google style guide.

Relevant resources:

enryH commented 2 years ago

which ones do you use now? Do you have a reference for the compatibility? (I used the numpy format so far as the default).

ri-heme commented 2 years ago

Sphinx's Napoleon extension supports Google style docstrings. Currently, the docstrings don't adhere to any specific convention. They resemble the Google style though, so it should be easy to change.