search

brainglobe / brainglobe-utils

Shared general purpose tools for the BrainGlobe project
MIT License
10 stars 1 forks source link

Add docstrings #19

Open adamltyson opened 8 months ago

adamltyson commented 8 months ago

And host API docs on the website

K-Meech commented 6 months ago

Currently there's a mix of docstring styles used in this repository e.g. numpy style vs sphinx style. Is there a default docstring style used for brainglobe? @alessandrofelder @willGraham01

adamltyson commented 6 months ago

It should be numpy (although obviously we haven't followed that convention yet).

If the BrainGlobe docs don't specify any particular standard (although they should!), we fall back to the Neuroinformatics Unit standards.

K-Meech commented 6 months ago

Thanks for the clarification @adamltyson ! As far as I can see, there isn't a docstring standard listed in the BrainGlobe docs - I'll go ahead and open an issue to fix that