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: update release notes with all deprecations for 1.12 release #19735

Merged
merged 4 commits into from Jan 2, 2024

Conversation

j-bowhay
Copy link
Member

Reference issue

What does this implement/fix?

Adds a couple missing entries to the deprecation section of the release notes

Additional information

cc @h-vetinari @tylerjereddy

@j-bowhay j-bowhay added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org backport-candidate This fix should be ported by a maintainer to previous SciPy versions. labels Dec 22, 2023
@j-bowhay j-bowhay added this to the 1.12.0 milestone Dec 22, 2023
doc/source/release/1.12.0-notes.rst Outdated Show resolved Hide resolved
doc/source/release/1.12.0-notes.rst Outdated Show resolved Hide resolved
[skip actions] [skip cirrus]
@j-bowhay j-bowhay changed the title DOC: update release note will all deprecations for 1.12 release DOC: update release notes with all deprecations for 1.12 release Dec 22, 2023
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.

The note about the sparse solvers is not correct/complete.

Comment on lines 279 to 282
- The deprecation of the ``tol`` argument of ``scipy.sparse.linalg.{gcrotmk,lgmres,minres,tfqmr}``
is now consistent with the other iterative solvers and will be removed in SciPy 1.14
in favour of ``rtol``. Further, the default value of ``atol`` for these functions is due
to change to ``0.0`` in SciPy 1.14.
Copy link
Member

Choose a reason for hiding this comment

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

The deprecation of tol happened across the board for all1 sparse solvers in 1.12, see #18488.

Footnotes

  1. Of course, there's an exception... 😑

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.

Modulo a slight refomulation this LGTM, so I'll put this in. Thanks! :)

doc/source/release/1.12.0-notes.rst Outdated Show resolved Hide resolved
Fix-up where GH UI did not allow suggestion
@h-vetinari
Copy link
Member

Doc build is broken by #19793. Since we're going to have to fix that separately anyway, I'm merging here.

@h-vetinari h-vetinari merged commit d131204 into scipy:main Jan 2, 2024
21 of 24 checks passed
tylerjereddy pushed a commit to tylerjereddy/scipy that referenced this pull request Jan 2, 2024
@tylerjereddy tylerjereddy mentioned this pull request Jan 2, 2024
3 tasks
@tylerjereddy tylerjereddy removed the backport-candidate This fix should be ported by a maintainer to previous SciPy versions. label Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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

4 participants