saeyslab / napari-sparrow

Other
17 stars 0 forks source link

Document code using docstrings #120

Closed SilverViking closed 2 months ago

SilverViking commented 1 year ago

Before we make the pipeline public we should document the code using docstrings for functions, classes and modules.

Several Python docstring styles are possible, with two popular ones being the numpy style and the google style. I would propose to use numpy style docstrings, since that is also the style that squidpy and spatialdata use internally.