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

gh-101100: Expand list of clean docs#103135

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
miss-islington merged 2 commits intopython:mainfromhugovk:docs-expand-clean-list
Mar 31, 2023

Conversation

hugovk
Copy link
Member

@hugovkhugovk commentedMar 30, 2023
edited by miss-islington
Loading

Follow on from#103116.

Expand list of clean docs files from 3 to 181. These files have no Sphinx warnings, and their presence in this list means that any new warnings introduced will fail the build.

The list was created by subtracting the list of files with warnings from a list of all files.

I tested with all of those, but found thattouching two clean files (https://github.com/python/cpython/blob/main/Doc/includes/wasm-notavail.rst andhttps://github.com/python/cpython/blob/main/Doc/whatsnew/changelog.rst) caused a cascade effect and resulted in a number of dirty files being rebuilt too, and failing the build. So those two have been omitted.

Automerge-Triggered-By: GH:hugovk

@CAM-Gerlach
Copy link
Member

IMO, I like@AlexWaygood 's proposal to have the list be an excludelist instead (i.e. a.nitignore 🤣 ) and then havetouch all files in/Docs and possibly/Misc/NEWS that matched a certain glob (i.e.**/*.rst) and didn't match one of the paths in the excludelist? That's a little more complicated, but it ensures new files are checked by default, highlight the files that still need to be fixed, and will reduce rather than increase the length of the list over time, and we can also use comments to explicit document why certain files are excluded (e.g. the two you mention above).

I tested with all of those, but found thattouching two clean files (main/Doc/includes/wasm-notavail.rst andmain/Doc/whatsnew/changelog.rst) caused a cascade effect and resulted in a number of dirty files being rebuilt too, and failing the build.

Just to explain why this is, for the record—the wasm statement gets injected into numerous individual files, so when it gets touched, all those dependents need to be rebuilt too, and touching the changelog means it rebuilds it from all the source files inMisc/NEWS. And the changelog most certainlyisn't clean, it just doesn't show up in the output because it is generated dynamically from numerous source files and thus evidently doesn't get checked itself (but the source files do).

hugovk reacted with thumbs up emoji

Copy link
Member

@AlexWaygoodAlexWaygood left a comment

Choose a reason for hiding this comment

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

LGTM. This is a clear improvement on the status quo, as it prevents regressions for these clean files.

IMO, I like@AlexWaygood 's proposal to have the list be an excludelist instead (i.e. a .nitignore 🤣 ) and then have touch all files in /Docs and possibly /Misc/NEWS that matched a certain glob (i.e. **/*.rst) and didn't match one of the paths in the excludelist? That's a little more complicated, but it ensures new files are checked by default, highlight the files that still need to be fixed, and will reduce rather than increase the length of the list over time, and we can also use comments to explicit document why certain files are excluded (e.g. the two you mention above).

I'm still in favour of this, but PRs are cheap. This can be all be done in a followup PR :)

CAM-Gerlach reacted with thumbs up emoji
@hugovk
Copy link
MemberAuthor

Agreed, let's get this merged before new warnings appear and refactor in followup.

AlexWaygood and CAM-Gerlach reacted with thumbs up emoji

@miss-islington
Copy link
Contributor

Status check is done, and it's a success ✅.

@miss-islingtonmiss-islington merged commit20c0f19 intopython:mainMar 31, 2023
@hugovkhugovk deleted the docs-expand-clean-list branchMarch 31, 2023 11:06
warsaw pushed a commit to warsaw/cpython that referenced this pull requestApr 11, 2023
Follow on frompython#103116.Expand list of clean docs files from 3 to 181. These files have no Sphinx warnings, and their presence in this list means that any new warnings introduced will fail the build.The list was created by subtracting the list of files with warnings from a list of all files.I tested with all of those, but found that `touch`ing two clean files (https://github.com/python/cpython/blob/main/Doc/includes/wasm-notavail.rst andhttps://github.com/python/cpython/blob/main/Doc/whatsnew/changelog.rst) caused a cascade effect and resulted in a number of dirty files being rebuilt too, and failing the build. So those two have been omitted.Automerge-Triggered-By: GH:hugovk
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@AlexWaygoodAlexWaygoodAlexWaygood approved these changes

@CAM-GerlachCAM-GerlachAwaiting requested review from CAM-Gerlach

Assignees
No one assigned
Labels
docsDocumentation in the Doc dirskip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

5 participants
@hugovk@CAM-Gerlach@miss-islington@AlexWaygood@bedevere-bot

[8]ページ先頭

©2009-2025 Movatter.jp