Add docstring to the morphology module
#6814
Conversation
There was a problem hiding this comment.
Hey @decorouz, this is a great start. Though, in #6761 we are recommending to pick only one module of the list so that other applicants have the chance to do so as well. E.g. #6799 was already created for the measure module. Could you update this pull request so that it only updates a module that's not already worked on?
lagru
added
the
📄 type: Documentation
Hi @lagru , I have updated the PR. Please review. |
INSTALL.rst
Outdated
| @@ -339,7 +339,7 @@ before you get started. | |||
| conda install -c conda-forge --file requirements/test.txt | |||
| conda install -c conda-forge pre-commit | |||
| # Install build dependencies of scikit-image | |||
| conda install -c conda-forge --file requirements/build.txt | |||
| pip install -r requirements/build.txt | |||
There was a problem hiding this comment.
For some reason GitHub shows three other commits that have been merged as part of this pull request (see https://github.com/scikit-image/scikit-image/pull/6814/commits). I'm confused why they show up in the diff for this PR, because they are already merged. 🤔
@decorouz, I can check out your branch locally and remove them for you if you want, but let me know if you want to give it a shot yourself and I'll try to help with that. 😉
There was a problem hiding this comment.
Yes, I would like to give it a shot myself.
I looked up stack-overflow for some pointers.
git checkout <branch>
git revert <commits>
git push origin <branch> --force
Would this address the issue?
There was a problem hiding this comment.
I'd probably do it with the git rebase -i HEAD~9 and then git push -f.
There was a problem hiding this comment.
Thanks @lagru
Following your advice, I was able to remove the confusing commits.
I also updated the docstring to match numpydoc style closely.
Please review.
There was a problem hiding this comment.
Hmm, I don't think removing the commits worked. 🤔 At least they still showed up on GitHub and when I checked you branch locally. I've removed them now. You should be able to pull these changes to your local branch with the following:
git branch add_description_skimage-backup
git fetch --all
git reset --hard origin/add_description_skimageThere was a problem hiding this comment.
Thank you @lagru.
That was some commits clean-up-job you did on my behalf.
decorouz
force-pushed
the
add_description_skimage
branch
from
56ca890
to
b069611
Compare
Co-authored-by: Lars Grüter <lagru+github@mailbox.org>
Co-authored-by: Lars Grüter <lagru+github@mailbox.org>
lagru
force-pushed
the
add_description_skimage
branch
from
24936de
to
d3926bf
Compare
Co-authored-by: Lars Grüter <lagru+github@mailbox.org>
skimage/morphology/__init__.py
Outdated
| @@ -1,3 +1,11 @@ | |||
| """Utilities that process images based on shapes. | |||
There was a problem hiding this comment.
I find there's a slight wording issue here, because it sounds as if images had to be "based on shapes" when, really, what is intended is that the actual processing is based on shapes (geometry).
There was a problem hiding this comment.
Valid point. Thank you.
I will improve the wordings.
Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
|
Hey, there hasn't been any activity on this pull request for more than 180 days. For now, we have marked it as "dormant" until there is some new activity. You are welcome to reach out to people by mentioning them here or on our forum if you need more feedback! Otherwise, we would be thankful for a short update, for example if you would like to continue or if you are okay with someone else doing so. In any case, thank you for your contributions so far! |
Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
|
Thank you for the contribution @decorouz ! |
Description
#6761 tasks:
Added summary description docstrings to
skimage.morphology.