GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

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

@hugovk hugovk commented May 20, 2024 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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).

image

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.

All reactions
hugovk added 3 commits May 20, 2024 09:42
@hugovk
Ensure no warnings are found in the NEWS file before a given line number
8692561
@hugovk
TEMP news nit
2ff144f
@hugovk
Fix news warnings
3aebebe
@hugovk
hugovk requested a review from ezio-melotti as a code owner May 20, 2024 15:15
@bedevere-app bedevere-app Bot added the awaiting core review label May 20, 2024
@hugovk hugovk added needs backport to 3.12 only security fixes needs backport to 3.13 only security fixes skip issue docs Documentation in the Doc dir and removed awaiting core review labels May 20, 2024
@hugovk hugovk mentioned this pull request May 20, 2024
gh-109975: Update 'What's New in Python 3.13' for beta #118694
Merged
JelleZijlstra
JelleZijlstra approved these changes May 20, 2024
View reviewed changes

@JelleZijlstra JelleZijlstra left a comment

Copy link
Copy Markdown
Member

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
All reactions
  • 👍 1 reaction
@bedevere-app bedevere-app Bot added the awaiting merge label May 20, 2024
@hugovk
Revert "TEMP news nit"
6a835f9
This reverts commit 2ff144f.
@hugovk
hugovk merged commit 034cf0c into python:main May 20, 2024
@miss-islington-app

miss-islington-app Bot commented May 20, 2024

Copy link
Copy Markdown

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app bedevere-app Bot removed the awaiting merge label May 20, 2024
@miss-islington-app

miss-islington-app Bot commented May 20, 2024

Copy link
Copy Markdown

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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@miss-islington-app miss-islington-app Bot assigned hugovk May 20, 2024
@miss-islington-app

miss-islington-app Bot commented May 20, 2024

Copy link
Copy Markdown

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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

hugovk added a commit to hugovk/cpython that referenced this pull request May 20, 2024
@hugovk
[3.13] Docs: Ensure no warnings are found in the NEWS file before a g…
bc701a2
…iven line number (pythonGH-119221)

(cherry picked from commit 034cf0c)

Co-authored-by: Hugo van Kemenade <[email protected]>
hugovk added a commit to hugovk/cpython that referenced this pull request May 20, 2024
@hugovk
Docs: Ensure no warnings are found in the NEWS file before a given li…
dc16534
…ne number (python#119221)

(cherry picked from commit 034cf0c)
@bedevere-app

bedevere-app Bot commented May 20, 2024

Copy link
Copy Markdown

GH-119261 is a backport of this pull request to the 3.13 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 only security fixes label May 20, 2024
@bedevere-app

bedevere-app Bot commented May 20, 2024

Copy link
Copy Markdown

GH-119261 is a backport of this pull request to the 3.13 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app

bedevere-app Bot commented May 20, 2024

Copy link
Copy Markdown

GH-119266 is a backport of this pull request to the 3.12 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label May 20, 2024
hugovk added a commit to hugovk/cpython that referenced this pull request May 20, 2024
@hugovk
[3.12] Docs: Ensure no warnings are found in the NEWS file before a g…
c0dcce5
…iven line number (pythonGH-119221)

(cherry picked from commit 034cf0c)

Co-authored-by: Hugo van Kemenade <[email protected]>
hugovk added a commit that referenced this pull request May 21, 2024
@hugovk
[3.13] Docs: Ensure no warnings are found in the NEWS file before a g…
1929b7e
…iven line number (GH-119221) (#119261)
hugovk added a commit that referenced this pull request May 21, 2024
@hugovk
[3.12] Docs: Ensure no warnings are found in the NEWS file before a g…
22bef96
…iven line number (GH-119221) (#119266)
@hugovk
hugovk deleted the no-new-news-nits2 branch May 23, 2024 10:35
@JelleZijlstra JelleZijlstra mentioned this pull request May 28, 2024
backport a9a74da 3.13 #119642
Closed
@hugovk hugovk mentioned this pull request May 28, 2024
gh-119118: Fix performance regression in tokenize module #119615
Merged
@hugovk hugovk mentioned this pull request Jul 8, 2024
NEWS: Fix Sphinx warnings and increase threshold for new news nits #121482
Merged
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
@hugovk @estyxx
Docs: Ensure no warnings are found in the NEWS file before a given li…
1f17d78
…ne number (python#119221)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes
@ezio-melotti 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.

Assignees

@hugovk hugovk

Labels

docs Documentation in the Doc dir skip issue

Projects

None yet

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.

2 participants

@hugovk @JelleZijlstra
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.