MRG: rewrite gifti docstrings; refactor init #407
Merged
Conversation
This file contains hidden or 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
matthew-brett
force-pushed
the
refactor-gifti-init-and-docstrings
branch
from
6095e62 to
4c1db3b
Compare
Responding to comments on Ben's previous PR nipy#403. Expand and fix docstrings and gifti attribute descriptions from gifti spec. Rewrite GiftiDataArray init to allow full initialization of object, that can be used from GiftiDataArray.from_array. The refactor of the init needs tests; I'll add these if y'all agree this init refactoring is the right thing to do.
Fix up a couple of duplicate test names. Remove test of setting string to DataArray - it's not allowed in the spec. Add tests for dataarray initialization.
Raise a specific error when parsing a gifti file that does not conform to the gifti spec.
matthew-brett
force-pushed
the
refactor-gifti-init-and-docstrings
branch
from
fcdb5a8 to
7f965d7
Compare
matthew-brett
changed the title
| """ | ||
|
|
||
| def __init__(self, key=0, label='', red=None, green=None, blue=None, | ||
| alpha=None): | ||
| self.key = key | ||
| self.label = label |
There was a problem hiding this comment.
Guessing you're removing this because GiftiLabel().label isn't referenced anywhere? If so, should it still be in the parameter list?
|
Didn't get to the tests, but the docstrings look good. Does |
`label` doesn't appear in the spec, and our code doesn't use it either.
matthew-brett
force-pushed
the
refactor-gifti-init-and-docstrings
branch
from
c1fe413 to
c2a8f52
Compare
|
Yes, I guess we could deprecate |
Deprecate GiftiDataArray.from_array in favor of GiftiDataArray constructor.
|
I read through the tests. Looks reasonable. I think this refactor of |
|
Ben - any comments here? |
|
OK - will merge this one tomorrow unless I hear otherwise. |
matthew-brett
added a commit
that referenced
this pull request
Feb 27, 2016
…cstrings MRG: rewrite gifti docstrings; refactor init Responding to comments on Ben's previous PR #403. Expand and fix docstrings and gifti attribute descriptions from gifti spec. Rewrite `GiftiDataArray` init to allow full initialization of object, that can be used from `GiftiDataArray.from_array`. Deprecate `GiftiDataArray.from_array` as redundant. Add tests. Fix up the tests - there were some duplicate test names so some tests were not being run. Remove unused `label` attribute of `GiftiLabel` object.
4 tasks
grlee77
pushed a commit
to grlee77/nibabel
that referenced
this pull request
Mar 15, 2016
…d-docstrings MRG: rewrite gifti docstrings; refactor init Responding to comments on Ben's previous PR nipy#403. Expand and fix docstrings and gifti attribute descriptions from gifti spec. Rewrite `GiftiDataArray` init to allow full initialization of object, that can be used from `GiftiDataArray.from_array`. Deprecate `GiftiDataArray.from_array` as redundant. Add tests. Fix up the tests - there were some duplicate test names so some tests were not being run. Remove unused `label` attribute of `GiftiLabel` object.
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.
Responding to comments on Ben's previous PR #403.
Expand and fix docstrings and gifti attribute descriptions from gifti
spec.
Rewrite GiftiDataArray init to allow full initialization of object, that
can be used from GiftiDataArray.from_array. Add tests.
Fix up the tests - there were some duplicate test names so some tests were not being run.
Remove unused
labelattribute ofGiftiLabelobject.