Skip to content
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

Open
adamltyson opened this issue Dec 15, 2023 · 3 comments
Open

Add docstrings #19

adamltyson opened this issue Dec 15, 2023 · 3 comments
Labels
enhancement New feature or request

Comments

@adamltyson
Copy link
Member

And host API docs on the website

@K-Meech
Copy link
Contributor

K-Meech commented Feb 15, 2024

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
Copy link
Member Author

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
Copy link
Contributor

K-Meech commented Feb 15, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants