Docs: Ensure no warnings are found in the NEWS file before a given line number #119221
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hugovk
added
needs backport to 3.12
JelleZijlstra
approved these changes
May 20, 2024
This reverts commit 2ff144f.
|
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
|
Sorry, @hugovk, I could not cleanly backport this to |
|
Sorry, @hugovk, I could not cleanly backport this to |
hugovk
added a commit
to hugovk/cpython
that referenced
this pull request
May 20, 2024
…iven line number (pythonGH-119221) (cherry picked from commit 034cf0c) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
hugovk
added a commit
to hugovk/cpython
that referenced
this pull request
May 20, 2024
…ne number (python#119221) (cherry picked from commit 034cf0c)
|
GH-119261 is a backport of this pull request to the 3.13 branch. |
|
GH-119261 is a backport of this pull request to the 3.13 branch. |
|
GH-119266 is a backport of this pull request to the 3.12 branch. |
hugovk
added a commit
to hugovk/cpython
that referenced
this pull request
May 20, 2024
…iven line number (pythonGH-119221) (cherry picked from commit 034cf0c) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Re: #118694 (comment)
We have tooling in place to ensure reST files under
Doc/don't introduce new Sphinx reference warnings.We ignore those that are in
.nitignorebecause 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 under
Misc/NEWS.d/, because during the Sphinx build, blurb compiles then into a giant 45k linebuild/NEWSwhich has 700+ warnings (and growing, because we don't check them).We do lint the news files with Sphinx Lint, but that doesn't catch everything, especially not bad references.
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.
This PR adds a check to ensure the top 200 lines remain clean. Most NEWS entries are under 10 lines long, and the biggest right now is 18 lines, so checking the top 200 will prevent new warnings being introduced.
I cleaned the top 200 lines (3 news files), but also introduced one temporarily to demonstrate how the CI fails. I'll revert that commit before merge.
📚 Documentation preview 📚: https://cpython-previews--119221.org.readthedocs.build/