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

DEP: extend some announced deprecations due to out-of-band 1.13 release #19892

Merged
merged 1 commit into from Jan 17, 2024

Conversation

h-vetinari
Copy link
Member

Implement the plan to delay some deprecations, due to the out-of-band release of 1.13 that was not accounted for when these deprecation warnings were written.

I've also moved the deprecation sections away from the top line of docstrings, because that is read/displayed by lots of tooling (e.g. IDEs), and should still contain the description of the function (even though we want to place the deprecation warning prominently).

@h-vetinari h-vetinari added backport-candidate This fix should be ported by a maintainer to previous SciPy versions. deprecated Items related to behavior that has been deprecated labels Jan 17, 2024
@h-vetinari h-vetinari added this to the 1.12.0 milestone Jan 17, 2024
@h-vetinari h-vetinari changed the title extend some announced deprecations due to out-of-band 1.13 release DEP: extend some announced deprecations due to out-of-band 1.13 release Jan 17, 2024
@h-vetinari
Copy link
Member Author

To summarize, this extends the following deprecation announcements, while keeping the originally intended ~1 year window between deprecation and removal.

In the future we may choose to completely avoid announcing specific versions for removal, but for now I just did a minimal/mechanical update here.

Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @h-vetinari. Looks like the test failure here are real but the rest seems reasonable.

I have been very busy recently so haven't kept up with all the discussions however this seems to match the conclusion of the linked discussion.

I think we should also consider bumping:

message = (
f"`scipy.{sub_package}.{module}.{attribute}` is deprecated along with "
f"the `scipy.{sub_package}.{module}` namespace. "
f"`scipy.{sub_package}.{module}.{attribute}` will be removed "
f"in SciPy 1.13.0, and the `scipy.{sub_package}.{module}` namespace "
f"will be removed in SciPy 2.0.0."
)

@h-vetinari
Copy link
Member Author

I think we should also consider bumping:

I did this now, even though I think it's kinda a borderline case in terms of utility IMO 🤷

Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, all seems in order. Are you ok updating the tracker too?

@j-bowhay j-bowhay merged commit 816d59d into scipy:main Jan 17, 2024
29 checks passed
@h-vetinari h-vetinari deleted the oob_dep branch January 17, 2024 18:38
@h-vetinari
Copy link
Member Author

Thanks, all seems in order. Are you ok updating the tracker too?

Yes, was planning to do that

@tylerjereddy
Copy link
Contributor

@h-vetinari thanks for doing this so quickly, and apologies for not having clearer/louder messaging on the timeline

tylerjereddy pushed a commit to tylerjereddy/scipy that referenced this pull request Jan 19, 2024
@tylerjereddy tylerjereddy removed the backport-candidate This fix should be ported by a maintainer to previous SciPy versions. label Jan 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated Items related to behavior that has been deprecated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants