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.

Sign up for GitHub

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

Jump to bottom

DOC: Docstrings + Getting started #14

Open

3 tasks

jerdra opened this issue Dec 7, 2021 · 1 comment

Assignees

Labels

documentation good first issue

Owner

jerdra commented Dec 7, 2021

Documentation should be updated with the following:

docstrings should be updated for all interfaces and functions (see here for styling: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
ensure that modules/sub-modules are appearing properly in Github pages when pushes are made to repository
Some getting started documentation with a simple example (perhaps using data from OSF or OpenNeuro?)

jerdra added documentation good first issue labels

jerdra changed the title ~~DOCS: Update documentation~~ DOC: Update documentation

jerdra changed the title ~~DOC: Update documentation~~ DOC: Docstrings + Getting started

Owner Author

jerdra commented Dec 9, 2021

Working on updating docstrings

jerdra self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment