Add reasonable defaults #133
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oruebel
reviewed
Aug 21, 2019
src/hdmf/backends/hdf5/h5tools.py
Outdated
| @@ -30,7 +30,7 @@ | |||
| class HDF5IO(HDMFIO): | |||
|
|
|||
| @docval({'name': 'path', 'type': str, 'doc': 'the path to the HDF5 file'}, | |||
| {'name': 'manager', 'type': BuildManager, 'doc': 'the BuildManager to use for I/O', 'default': None}, | |||
| {'name': 'manager', 'type': (TypeMap, BuildManager), 'doc': 'the BuildManager to use for I/O', 'default': None}, | |||
There was a problem hiding this comment.
The doc should be updated to reflect the new behavior. Should the name of the arg also change?
There was a problem hiding this comment.
The name should stay, for backwards compatibility. I will update the doc though
oruebel
previously approved these changes
Aug 21, 2019
Codecov Report
@@ Coverage Diff @@
## dev #133 +/- ##
========================================
- Coverage 69.05% 69% -0.06%
========================================
Files 24 24
Lines 4967 4971 +4
Branches 1137 1139 +2
========================================
Hits 3430 3430
- Misses 1170 1172 +2
- Partials 367 369 +2
Continue to review full report at Codecov.
|
oruebel
approved these changes
Sep 25, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Remove boilerplate requirements.
How to test the behavior?
run test suite
Checklist
flake8from the source directory.#XXXnotation whereXXXis the issue number ? By including "Fix #XXX" you allow GitHub to close the corresponding issue.