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
RF - Direction getters naming #2033
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2033 +/- ##
==========================================
+ Coverage 91.21% 91.22% +0.01%
==========================================
Files 250 252 +2
Lines 31803 31832 +29
Branches 3340 3340
==========================================
+ Hits 29009 29039 +30
Misses 2074 2074
+ Partials 720 719 -1
|
Hi @gabknight, Thank you for this update. If this naming conventions change is really necessary, we will need to set up a deprecation cycle for at least 2 releases and keep the old system (release 1.0.0 was an exception for breaking without any deprecation cycle)
Let me know if you need help with that and I will create a PR on local branch/dipy repo. |
Hi @skoudoro, thanks for your response. I wasn't sure how to do the deprecation for a class. Let me know if you would do it differently. Maybe instead of defining a function, I should just do The warning is in peak_direction_getter .py rather than .pyx. Do you think this is an issue? |
Hi @gabknight, I think it is good the way you do it! It is just missing a small test to make sure that the warning popup. Furthermore, I need to test it quickly. Thank you ! |
292fbbf
to
39ee9a9
Compare
@skoudoro, Thanks I added the test. Do you know why those build failed? |
Not yet, needs to look into it.
Anyway, I need to look. |
This should help with this: dipy#2033 (comment). It seems that nibabel has upped their minimal requirement for 3.0 and we can follow along.
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.
You can rebase this PR @gabknight, error on Travis has been fixed.
As I said below, There is one more deprecation to do and this PR will be ready to go. Thank you
@@ -56,7 +56,7 @@ cdef int closest_peak(np.ndarray[np.float_t, ndim=2] peak_dirs, | |||
return 0 | |||
return 1 | |||
|
|||
cdef class BaseDirectionGetter(DirectionGetter): | |||
cdef class BasePmfDirectionGetter(DirectionGetter): |
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.
BaseDirectionGetter
needs a deprecation cycle as you did for EuDXDirectionGetter
.
Can you add this deprecation and a small test for it?
Thank you
6a30784
to
fb05330
Compare
Sorry for the delay but thank you @gabknight! Everything looks good and you can continue with #2036. merging |
Change direction getter naming in preparation of new direction getters based on peaks object (PR in prep).