Skip to content
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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

DavidBreuer
Copy link
Contributor

@DavidBreuer DavidBreuer commented May 1, 2018

Description

Following the discussion in #2762, I provide a basic documentation for all skimage subpackages.

Checklist

References

Not related to any issue but see discussion in #2762.

For reviewers

(Don't remove the checklist below.)

  • Check that the PR title is short, concise, and will make sense 1 year
    later.
  • Check that new functions are imported in corresponding __init__.py.
  • Check that new features, API changes, and deprecations are mentioned in
    doc/release/release_dev.rst.

@pep8speaks
Copy link

pep8speaks commented May 1, 2018

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

@sciunto sciunto requested a review from emmanuelle May 3, 2018 06:17
@soupault
Copy link
Member

soupault commented May 3, 2018

@soupault soupault added 📄 type: Documentation Updates, fixes and additions to documentation 🧐 Needs review labels May 3, 2018
@soupault soupault added this to the 0.15 milestone May 3, 2018
Copy link
Member

@emmanuelle emmanuelle left a 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
Copy link
Member

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)

Copy link
Member

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?

@soupault soupault modified the milestones: 0.15, 0.16 Apr 20, 2019
@sciunto
Copy link
Member

sciunto commented Sep 22, 2019

@emmanuelle Would you like to have a look at this PR and try eventually to make it good for a merge?

Base automatically changed from master to main February 18, 2021 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧐 Needs review 📄 type: Documentation Updates, fixes and additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants