gh-101100: Fix Sphinx warnings in whatsnew/2.0.rst
#112351
Conversation
whatsnew/2.0.rstwhatsnew/2.0.rst
|
It may be easier to just keep these files in There may be a lot of dead references in the old Changelog. If we do not want to rewrite them every time some API is deprecated and removed, we can just ignore warnings in old files. |
I would like to eventually remove the custom To get to the clean slate, we can fix or ignore warnings in old files. CAM suggested adding functionality to Sphinx to be able to ignore warnings in given files, which could work, but that functionality doesn't exist yet, and our Sphinx version pin is lagging to help distros. For really old files that aren't read much, I think it's fine to ignore the warnings that aren't trivially fixable.
Anyway, I think it would be a good idea to blanket ignore deprecations/removals in |
|
Blindly ignoring warnings can hide real errors. Adding outdated Python 2 and Python 1 names to the ignore list will ignore them in all other files, where they perhaps should not be ignored. Also it can conflict with existing names. Names like |
|
Yes, I'd recommend only ignoring removed modules: ('py:mod', 'cPickle'),
('py:mod', 'sunaudiodev'),Or other things that are fully qualified, like: ('py:meth', 'unittest.TestCase.assertDictContainsSubset'), |
|
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
|
Sorry, @hugovk, I could not cleanly backport this to |
|
Sorry, @hugovk, I could not cleanly backport this to |
…thonGH-112351) (cherry picked from commit a00b41b) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
|
GH-115902 is a backport of this pull request to the 3.12 branch. |
|
GH-115903 is a backport of this pull request to the 3.11 branch. |
…thonGH-112351) (cherry picked from commit a00b41b) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
… (#115902) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
… (#115903) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
…2351) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
…2351) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
…2351) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
On the one hand, we don't want to spend time fixing the old What's New files.
But on the other, the ultimate aim of #101100 is to turn all warnings into errors, which means these files need tackling.
To balance this, let's do the minimum needed, and fix these 87 warnings by silencing with the
!or fix them if it's straightforward.📚 Documentation preview 📚: https://cpython-previews--112351.org.readthedocs.build/