Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Docs: Ensure no warnings are found in the NEWS file before a given line number#119221

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
hugovk merged 4 commits intopython:mainfromhugovk:no-new-news-nits2
May 20, 2024

Conversation

hugovk
Copy link
Member

@hugovkhugovk commentedMay 20, 2024
edited by github-actionsbot
Loading

Re:#118694 (comment)

We have tooling in place to ensure reST files underDoc/ 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 underMisc/NEWS.d/, because during the Sphinx build,blurb compiles then into a giant 45k linebuild/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/

Copy link
Member

@JelleZijlstraJelleZijlstra left a 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.

hugovk reacted with thumbs up emoji
This reverts commit2ff144f.
@hugovkhugovk merged commit034cf0c intopython:mainMay 20, 2024
@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

Sorry,@hugovk, I could not cleanly backport this to3.13 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker 034cf0c3167c850c8341deb61e210cb0dbcdb02d 3.13

@miss-islington-app
Copy link

Sorry,@hugovk, I could not cleanly backport this to3.12 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker 034cf0c3167c850c8341deb61e210cb0dbcdb02d 3.12

hugovk added a commit to hugovk/cpython that referenced this pull requestMay 20, 2024
…iven line number (pythonGH-119221)(cherry picked from commit034cf0c)Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
hugovk added a commit to hugovk/cpython that referenced this pull requestMay 20, 2024
@bedevere-app
Copy link

GH-119261 is a backport of this pull request to the3.13 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.13bugs and security fixes labelMay 20, 2024
@bedevere-app
Copy link

GH-119261 is a backport of this pull request to the3.13 branch.

@bedevere-app
Copy link

GH-119266 is a backport of this pull request to the3.12 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.12only security fixes labelMay 20, 2024
hugovk added a commit to hugovk/cpython that referenced this pull requestMay 20, 2024
…iven line number (pythonGH-119221)(cherry picked from commit034cf0c)Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull requestMay 21, 2024
hugovk added a commit that referenced this pull requestMay 21, 2024
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@JelleZijlstraJelleZijlstraJelleZijlstra approved these changes

@ezio-melottiezio-melottiAwaiting requested review from ezio-melottiezio-melotti is a code owner

Assignees

@hugovkhugovk

Labels
docsDocumentation in the Doc dirskip issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants
@hugovk@JelleZijlstra

[8]ページ先頭

©2009-2025 Movatter.jp