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

Keep deprecated functions available in skimage.filters #6701

Merged
merged 1 commit into from Jan 25, 2023

Conversation

lagru
Copy link
Member

@lagru lagru commented Jan 25, 2023

Description

While compute_hessian_eigenvalues and inverse are deprecated, removing them from the module level would break code for users who use the import path skimage.filters.DEPRECATED_FUNC. The whole purpose of a deprecation cycle is to give users the chance to avoid broken code!

Drawn out of #6700 in the hope that this can be quickly merged into 0.20.

Checklist

  • Docstrings for all functions
  • Gallery example in ./doc/examples (new features only)
  • Benchmark in ./benchmarks, if your changes aren't covered by an
    existing benchmark
  • Unit tests
  • Clean style in the spirit of PEP8
  • Descriptive commit messages (see below)

For reviewers

  • 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.
  • There is a bot to help automate backporting a PR to an older branch. For
    example, to backport to v0.19.x after merging, add the following in a PR
    comment: @meeseeksdev backport to v0.19.x
  • To run benchmarks on a PR, add the run-benchmark label. To rerun, the label
    can be removed and then added again. The benchmark output can be checked in
    the "Actions" tab.

While it is deprecated, removing it from the module level would break
code for users who use the import path skimage.filters.DEPRECATED_FUNC.
The whole purpose of a deprecation cycle is to give users the chance to
avoid broken code.
@lagru lagru added 🩹 type: Bug fix Fixes unexpected or incorrect behavior 🔽 Deprecation Involves deprecation labels Jan 25, 2023
@lagru lagru added this to the 0.20 milestone Jan 25, 2023
lagru added a commit to lagru/scikit-image that referenced this pull request Jan 25, 2023
This reverts commit 6131bbb. These
changes were moved to scikit-image#6701 in the hope that this can be quickly merged
into 0.20.
@lagru lagru changed the title Keep deprecated functions for skimage.filters Keep deprecated functions available in skimage.filters Jan 25, 2023
@stefanv stefanv merged commit 28cdb3b into scikit-image:main Jan 25, 2023
@lagru lagru deleted the keep-deprecated branch January 26, 2023 15:28
@lagru
Copy link
Member Author

lagru commented Jan 26, 2023

Thanks for the quick reviews. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🩹 type: Bug fix Fixes unexpected or incorrect behavior 🔽 Deprecation Involves deprecation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants