FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Docs: Ensure no warnings are found in the NEWS file before a given line number by hugovk · Pull Request #119221 · python/cpython · GitHub

/ cpython Public

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

Merged
hugovk merged 4 commits into
python:mainfrom
hugovk:no-new-news-nits2
May 20, 2024
ConversationCommits (4)ChecksFiles changed
Merged

Docs: Ensure no warnings are found in the NEWS file before a given line number#119221
hugovk merged 4 commits into
python:mainfrom
hugovk:no-new-news-nits2

Conversation

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

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

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/

hugovk requested a review from ezio-melotti as a code owner May 20, 2024 15:15
hugovk added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes skip issue docs Documentation in the Doc dir and removed awaiting core review labels May 20, 2024
hugovk mentioned this pull request May 20, 2024
Merged
JelleZijlstra approved these changes May 20, 2024
View reviewed changes

JelleZijlstra left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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 merged commit 034cf0c into python:main May 20, 2024

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.
🐍🍒⛏🤖

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

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

hugovk added a commit to hugovk/cpython that referenced this pull request May 20, 2024
[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 <1324225+hugovk@users.noreply.github.com>
hugovk added a commit to hugovk/cpython that referenced this pull request May 20, 2024
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 Bot commented May 20, 2024

Copy link
Copy Markdown

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

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

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.

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.

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
[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 <1324225+hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request May 21, 2024
[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
[3.12] Docs: Ensure no warnings are found in the NEWS file before a g…
22bef96 
…iven line number (GH-119221) (#119266)
hugovk deleted the no-new-news-nits2 branch May 23, 2024 10:35
JelleZijlstra mentioned this pull request May 28, 2024
Closed
hugovk mentioned this pull request May 28, 2024
Merged
hugovk mentioned this pull request Jul 8, 2024
Merged
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
Docs: Ensure no warnings are found in the NEWS file before a given li…
1f17d78 
…ne number (python#119221)
This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

JelleZijlstra JelleZijlstra approved these changes
ezio-melotti Awaiting requested review from ezio-melotti ezio-melotti is a code owner

Assignees

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.

2 participants

Back | FazBrowse Home | New Git URL