-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Provide basic documentation for skimage subpackages #3046
base: main
Are you sure you want to change the base?
Conversation
Hello @DavidBreuer! Thanks for updating the PR. Cheers ! There are no PEP8 issues in this Pull Request. 🍻 Comment last updated on May 01, 2018 at 12:59 Hours UTC |
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.
Thank you very much for these explanations. They will also appear in the API page on the online documentation (http://scikit-image.org/docs/stable/api/api.html) so we have to make sure that it's not too long. I would juste remove the part on filters.rank
.
|
||
.. [1] https://en.wikipedia.org/wiki/Digital_image_processing#Filtering | ||
|
||
Subpackages |
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.
This part will not be rendered well in the API page of the documentation (http://scikit-image.org/docs/stable/api/api.html)
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.
@emmanuelle can you elaborate on why?
@emmanuelle Would you like to have a look at this PR and try eventually to make it good for a merge? |
Description
Following the discussion in #2762, I provide a basic documentation for all skimage subpackages.
Checklist
./doc/examples
(new features only)References
Not related to any issue but see discussion in #2762.
For reviewers
(Don't remove the checklist below.)
later.
__init__.py
.doc/release/release_dev.rst
.