-
-
Notifications
You must be signed in to change notification settings - Fork 30.9k
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
gh-101100: Use list of 'dirty' docs, with warnings, instead of a clean list #103191
Merged
Conversation
This file contains 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
AlexWaygood
reviewed
Apr 2, 2023
CAM-Gerlach
reviewed
Apr 2, 2023
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.
Looks good overall, thanks, just a couple comments.
AlexWaygood
reviewed
Apr 2, 2023
arhadthedev
reviewed
Apr 2, 2023
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood
approved these changes
Apr 3, 2023
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.
LGTM, thanks!
gaogaotiantian
pushed a commit
to gaogaotiantian/cpython
that referenced
this pull request
Apr 8, 2023
…a clean list (python#103191) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
warsaw
pushed a commit
to warsaw/cpython
that referenced
this pull request
Apr 11, 2023
…a clean list (python#103191) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As suggested in #103116 (comment), keep a "dirty" list of docs with warnings, instead of a "clean" list of docs with warnings.
This means we have a checklist of files to work on to clean, and any new files added to the
Doc/
directory would by default be tested with nitpicks enabled.The functionality is essentially the same, the clean docs are
touch
ed and rebuilt.In calculating the clean files:
*.rst
files fromDoc/
Doc/venv/
Doc/tools/dirty-files.txt
Doc/includes/wasm-notavail.rst
andDoc/whatsnew/changelog.rst
, which would trigger dirty files to be rebuilt