GeezerVison is showing github.com — Docs: Ensure no warnings are found in the NEWS file before a given line number by hugovk · Pull Request #119221 · python/cpython
Conversation
hugovk
commented
May 20, 2024
•
edited by github-actions
Bot
Loading
Uh oh!
There was an error while loading. Please reload this page.
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 .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 under Misc/NEWS.d/, because during the Sphinx build, blurb compiles then into a giant 45k line build/NEWS which 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/
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice if the error message referenced the specific blurb file instead of the giant NEWS file, but I understand that would be difficult to achieve.
Thanks, this is a great improvement.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
hugovk reacted with thumbs up emoji
|
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
Sorry, @hugovk, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 034cf0c3167c850c8341deb61e210cb0dbcdb02d 3.13
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
Sorry, @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 034cf0c3167c850c8341deb61e210cb0dbcdb02d 3.12
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Reviewers
ezio-melotti
Awaiting requested review from ezio-melotti
ezio-melotti is a code owner
Uh oh!
There was an error while loading. Please reload this page.
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
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.
|