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.

Sign up for GitHub

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

Jump to bottom

Are lpi_filter and ridges part of our public API? #6593

Open
lagru opened this issue Oct 24, 2022 · 2 comments · May be fixed by #6700
Open

Are lpi_filter and ridges part of our public API? #6593

lagru opened this issue Oct 24, 2022 · 2 comments · May be fixed by #6700
Labels
📜 type: API Involves API change(s)

Comments

@lagru
Copy link
Member

lagru commented Oct 24, 2022 •
edited
Loading

Currently, the import path of skimage.filters.lpi_filter, skimage.filters.ridges and skimage.filters.lpi_filter.forward_filter lack a leading underscore, which implies that they are part of our public API. However, both are not included in our API documentation.

I propose to be more explicit about this and make them private by renaming to _lpi_filter. Or do we have a good reason to break from the established default skimage.submodule.function pattern in this case?

Edit: filter_forward was addressed in #6883.
@lagru lagru added the 📜 type: API Involves API change(s) label Oct 24, 2022
@lagru lagru changed the title Are filters.lpi_filter, filters.ridges and forward_filter part of our public API? Are lpi_filter, ridges and forward_filter part of our public API? Oct 24, 2022
@stefanv
Copy link
Member

stefanv commented Oct 25, 2022 •
edited
Loading

Go ahead and rename those submodules to be private, thanks!

@stefanv
Copy link
Member

stefanv commented Oct 25, 2022

(They are accessible, but already hidden after we added the lazy loader.)

@lagru lagru linked a pull request Jan 24, 2023 that will close this issue
Open
@lagru lagru changed the title Are lpi_filter, ridges and forward_filter part of our public API? Are lpi_filter and ridges part of our public API? Apr 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📜 type: API Involves API change(s)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Prefix private modules in skimage.filters with underscore lagru/scikit-image
2 participants
@stefanv @lagru