Skip to content

gh-109975: Update 'What's New in Python 3.13' for beta #118694

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

Merged
merged 2 commits into from
May 7, 2024

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented May 7, 2024

Plus fix some Sphinx warnings in the NEWS changelog (there are hundreds more because we don't check them in CI).


📚 Documentation preview 📚: https://cpython-previews--118694.org.readthedocs.build/

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir awaiting core review labels May 7, 2024
@Yhg1s Yhg1s merged commit 6cf7067 into python:main May 7, 2024
28 checks passed
@hugovk hugovk deleted the docs-3.13 branch May 7, 2024 10:47
Improve validation logic in the C implementation of :meth:`datetime.fromisoformat`
to better handle invalid years. Patch by Vlad Efanov.
Improve validation logic in the C implementation of
:meth:`datetime.datetime.fromisoformat` to better handle invalid years.
Copy link
Member

Choose a reason for hiding this comment

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

Do you know why these weren't caught on the PR adding them? Is there some configuration change we can make so that NEWS entries get linted properly by Sphinx?

Copy link
Member Author

Choose a reason for hiding this comment

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

We do lint them with Sphinx Lint, but that doesn't catch everything, especially not bad references.

We only check for warnings from a Sphinx build in files under Doc/:

all_rst = {
str(rst)
for rst in Path("Doc/").rglob("*.rst")
if rst.parts[1] not in EXCLUDE_SUBDIRS
}

We ignore those that are in .nitignore because they've not been "cleaned" yet, because we don't want to hassle people over warnings which they didn't introduce.

Similarly, we ignore the news files, because during the Sphinx build, they get compiled into a giant 45k line build/NEWS which has 700+ warnings (and growing, because we don't check them).

And so we don't want to warn for every single PR that adds a small NEWS blurb about those 700 warnings that they didn't introduce.

New entries are added to the top of the compiled NEWS file. One option would be to add a check to ensure the top X lines remain clean. Most NEWS entries are under 10 lines long, and the biggest right now is 18 lines, so checking something like the top 200 or so would prevent new warnings being introduced.

I started work on this in February, see hugovk#61. I'll pick this up again.

Copy link
Member Author

Choose a reason for hiding this comment

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

Please see PR #119221.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants