gh-77024: test.support: Improve documentation#92513
Merged
JelleZijlstra merged 6 commits intopython:mainfrom May 27, 2022
Merged
gh-77024: test.support: Improve documentation#92513JelleZijlstra merged 6 commits intopython:mainfrom
JelleZijlstra merged 6 commits intopython:mainfrom
Conversation
This is a rework of python#5774 on current main. I was a bit more conservative in making changes than the original PR. See @csabella's comments on issue python#77024 and the discussion on python#5774 for explanations of several of the changes. Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
vstinner
reviewed
May 23, 2022
AlexWaygood
reviewed
May 25, 2022
Member
AlexWaygood
left a comment
There was a problem hiding this comment.
Thanks, this looks like a big improvement! A few notes:
Comment on lines
+1337
to
+1340
| Set to a filename containing the :data:`FS_NONASCII` character, if it exists. | ||
| This guarantees that if the filename exists, it can be encoded and decoded | ||
| with the default filesystem encoding. This allows tests that require a | ||
| non-ASCII filename to be easily skipped on platforms where they can't work. |
Member
There was a problem hiding this comment.
This currently feels like it leads with the implementation, and finishes with why it's useful ("This allows tests that require a non-ASCII filename to be easily skipped on platforms where they can't work"). The other way around might be better.
Member
Author
There was a problem hiding this comment.
I see your point, but I feel like the current sequence is more in line with the surrounding TESTFN_* paragraphs.
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
JelleZijlstra
commented
May 26, 2022
Member
Author
|
Thanks for your review @AlexWaygood! |
AlexWaygood
approved these changes
May 26, 2022
Member
AlexWaygood
left a comment
There was a problem hiding this comment.
Just two more nits I spotted, otherwise looks great!
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood
approved these changes
May 27, 2022
Contributor
|
Thanks @JelleZijlstra for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11. |
|
GH-93291 is a backport of this pull request to the 3.11 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 27, 2022
This is a rework of pythonGH-5774 on current main. I was a bit more conservative in making changes than the original PR. See @csabella's comments on issue pythonGH-77024 and the discussion on pythonGH-5774 for explanations of several of the changes. Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 8995177) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 27, 2022
This is a rework of pythonGH-5774 on current main. I was a bit more conservative in making changes than the original PR. See @csabella's comments on issue pythonGH-77024 and the discussion on pythonGH-5774 for explanations of several of the changes. Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 8995177) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
miss-islington
added a commit
that referenced
this pull request
May 27, 2022
This is a rework of GH-5774 on current main. I was a bit more conservative in making changes than the original PR. See @csabella's comments on issue GH-77024 and the discussion on GH-5774 for explanations of several of the changes. Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 8995177) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
miss-islington
added a commit
that referenced
this pull request
May 27, 2022
This is a rework of GH-5774 on current main. I was a bit more conservative in making changes than the original PR. See @csabella's comments on issue GH-77024 and the discussion on GH-5774 for explanations of several of the changes. Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 8995177) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
This is a rework of #5774 on current main. I was a bit more
conservative in making changes than the original PR.
See @csabella's comments on issue #77024 and the discussion
on #5774 for explanations of several of the changes.
Co-authored-by: Cheryl Sabella cheryl.sabella@gmail.com