-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docstrings #19
Comments
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 |
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. |
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 |
And host API docs on the website
The text was updated successfully, but these errors were encountered: