-
Notifications
You must be signed in to change notification settings - Fork 45
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 to scripts #80
Conversation
I'm happy to go through and review this but I have a quick question before getting started: are we trying to follow |
I answer to your question with a question: what is the |
There's nothing in particular to highlight that a function will save a file to disk (see, for example, But I think, generally speaking, following |
Ok, then: I'm going to momentarily close this issue, make the docstrings more numpyish, but maintain the "Outcome" for when we save something to the disk or print something on screen. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Closes #1 .
Added docstrings for
utils.py
andviz.py
.Are we happy with the docstrings or should we expand more
main()
inphys2bids.py
?