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

DOC: add missing deprecations from 1.13.0 release notes #20435

Merged
merged 1 commit into from
Apr 10, 2024

Conversation

j-bowhay
Copy link
Member

Reference issue

remake of #20431

What does this implement/fix?

Several deprecations were missing from the 1.13 release notes, this PR adds them

Additional information

cc @tylerjereddy @h-vetinari @lucascolley sorry not sure how I missed this, have been very busy with uni this year

@github-actions github-actions bot added the Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org label Apr 10, 2024
@j-bowhay j-bowhay 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 Apr 10, 2024
@j-bowhay j-bowhay added this to the 1.13.1 milestone Apr 10, 2024
Copy link
Member

@lucascolley lucascolley left a comment

Choose a reason for hiding this comment

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

LGTM, will let @h-vetinari check nothing has been missed.

@lucascolley
Copy link
Member

Actually, I think we need to add that these changes occurred in 1.13.0 but were missed from the notes at the time.

Copy link
Member

@h-vetinari h-vetinari 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!

@h-vetinari
Copy link
Member

Actually, I think we need to add that these changes occurred in 1.13.0 but were missed from the notes at the time.

I think we should just merge this for main & the release branch (not sure if the versioned website is built from the tag or the branch - I hope it's the latter?), and if possible, ask @tylerjereddy to update the notes that are attached to the github release for 1.13.0. That way all major places (to my knowledge) where people can look at the release notes would be up to date, even without a 1.13.1 release.

@lucascolley
Copy link
Member

Okay, SGTM. I suppose I was thinking of a case where someone checked the release notes on release, thought "great, no expired deprecations!", then later tries to upgrade, runs into problems and doesn't understand why the expired deprecations have now appeared.

That is admittedly very niche, so let's get this in. Thanks all!

@lucascolley lucascolley merged commit 27381ff into scipy:main Apr 10, 2024
28 of 30 checks passed
@j-bowhay
Copy link
Member Author

Looks like the doc failure here was real

@lucascolley
Copy link
Member

Ah sorry, missed that. I can fix it.

@tylerjereddy
Copy link
Contributor

I've updated the GitHub release page version of the 1.13.0 release notes accordingly.

@j-bowhay
Copy link
Member Author

I've updated the GitHub release page version of the 1.13.0 release notes accordingly.

Many thanks!

@@ -140,13 +140,38 @@ Deprecated features
- Complex dtypes in ``PchipInterpolator`` and ``Akima1DInterpolator`` have
been deprecated and will raise an error in SciPy 1.15.0. If you are trying
to use the real components of the passed array, use ``np.real`` on ``y``.

- Non-integer values of ``n`` together with ```exact=True`` are deprecated for
Copy link
Contributor

Choose a reason for hiding this comment

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

I think there's a small blemish here too, the extra preceding backtick shows up in the rendered version of the relnotes:

https://scipy.github.io/devdocs/release/1.13.0-notes.html#deprecated-features

Pretty minor though

@h-vetinari
Copy link
Member

Thanks a lot @tylerjereddy!

I propose we should still backport this to the release branch before the regular batch of PRs, so that the 1.13 docs online get updated as well.

@tylerjereddy
Copy link
Contributor

I suppose you mean to manually rebuild and reupload the docs for the 1.13.0 release with the expired deprecations added?

That I certainly don't normally do, but I'll add a calendar reminder to consider doing it at least. I don't know if that would really have much to do with backport order. If I just checkout the tag, apply the release notes patches only (without committing them), and re-upload it wouldn't likely matter much if things get backported as they usually do I suspect.

I also need to carefully clean out the backport-labelled PRs, that's a mess now, but I'm a bit swamped on grant writing.

@h-vetinari
Copy link
Member

h-vetinari commented Apr 11, 2024

I suppose you mean to manually rebuild and reupload the docs for the 1.13.0 release with the expired deprecations added?

No, it was not my intention to ask for manual work (except one of us doing the backport PR), but it's possible I misunderstood how our docs get published. My hope would have been that any commit on release/1.13.x pushes new docs to https://docs.scipy.org/doc/scipy-1.13.0/. If that's not the case, then we can wait until 1.13.1.

@tylerjereddy
Copy link
Contributor

An nope, although @tupui probably would agree with your wishes of it being more streamlined like the devdocs stuff.

There's this thing where we do make dist and then make upload, and then it goes to some server owned by Enthought team, so different than the devdocs route.

Maybe we'll streamline that at some point, it can get hard to reason about what is going on with those two routes to doc upload.

@ev-br
Copy link
Member

ev-br commented Apr 12, 2024

I also need to carefully clean out the backport-labelled PRs, that's a mess now, but I'm a bit swamped

Is there something we can help with?

@tylerjereddy tylerjereddy mentioned this pull request May 2, 2024
10 tasks
@tylerjereddy tylerjereddy removed the backport-candidate This fix should be ported by a maintainer to previous SciPy versions. label May 23, 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 Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants