-
Notifications
You must be signed in to change notification settings - Fork 161
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
[ENH] Some missing docstrings for bidsschematools #1413
Conversation
Codecov ReportBase: 88.65% // Head: 88.88% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #1413 +/- ##
==========================================
+ Coverage 88.65% 88.88% +0.23%
==========================================
Files 11 11
Lines 1084 1080 -4
==========================================
- Hits 961 960 -1
+ Misses 123 120 -3
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
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.
Looks good, approval and merge should push to rtd's.
hey @TheChymera tagging you here as well, if you'd like to take a look! |
@@ -514,7 +514,7 @@ def select_schema_dir( | |||
according to the respective schema version, e.g. "1.7.0". | |||
If the path starts with the string "{module_path}" it will be expanded relative to the | |||
module path. | |||
schema_version : str or None | |||
schema_version : str | None |
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.
Above you went in the other direction.
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.
Ah missed this one- it should be an or
. From what I saw from numpydoc that's what's used
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.
Mostly good. We should pick a convention for describing types and stick with it, though.
Adding some more docstrings for the bidsschematools.