Change feret_diameter to feret_diameter_max#4820
Change feret_diameter to feret_diameter_max#4820jni merged 3 commits intoscikit-image:masterfrom maxfrei750:patch-1
Conversation
The calculated property is the maximum Feret diameter and should IMHO be named as such to avoid confusion.
|
I thought |
|
@maxfrei750 It looks like some tests are failing. I’m on my phone so I can’t investigate right now. The changes look ok to me. @scikit-image/core I’m agnostic on On the other hand, we have max-intensity, min-intensity, and mean-intensity... Any thoughts? |
|
@jni I already saw the errors, however I don't understand what they are caused by. There are loads of key errors like the following one in the "collection" section: Concerning |
|
The docstring in which doesn't match the update name. There is some code in |
|
@grlee77 Thanks for the hint. Changing the docstring has fixed the problems. |
grlee77
left a comment
There was a problem hiding this comment.
This looks good to me. I don't have a strong opinion on feret_diameter_max vs. max_feret_diameter. The second reads a bit better to me, but the first would be easier to quickly find in the list if someone is searching for "Feret diameter".
There is an unrelated matplotlib-related CI failure in one case on Travis that shouldn't block this going in once Appveyor completes.
|
I'd like to finalize this PR. Any final thoughts concerning the naming? |
|
I like the way it is now---it is more easily discoverable. |
|
Looks like we have a consensus!!! Thank you @maxfrei750! |
Description
Fixes #4817
later.
__init__.py.doc/release/release_dev.rst.