Skip to content
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-77024: test.support: Improve documentation #92513

Merged
merged 6 commits into from
May 27, 2022

Conversation

JelleZijlstra
Copy link
Member

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

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>
Doc/library/test.rst Outdated Show resolved Hide resolved
Doc/library/test.rst Outdated Show resolved Hide resolved
Doc/library/test.rst Outdated Show resolved Hide resolved
Doc/library/test.rst Outdated Show resolved Hide resolved
Doc/library/test.rst Outdated Show resolved Hide resolved
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

LGTM, thanks.

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

Thanks, this looks like a big improvement! A few notes:

Doc/library/test.rst Outdated Show resolved Hide resolved
Doc/library/test.rst Outdated Show resolved Hide resolved
Doc/library/test.rst Show resolved Hide resolved
Doc/library/test.rst Outdated Show resolved Hide resolved
Doc/library/test.rst Outdated Show resolved Hide resolved
Doc/library/test.rst Outdated Show resolved Hide resolved
Doc/library/test.rst Outdated Show resolved Hide resolved
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.
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

I see your point, but I feel like the current sequence is more in line with the surrounding TESTFN_* paragraphs.

Doc/library/test.rst Outdated Show resolved Hide resolved
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Doc/library/test.rst Show resolved Hide resolved
Doc/library/test.rst Outdated Show resolved Hide resolved
@JelleZijlstra
Copy link
Member Author

Thanks for your review @AlexWaygood!

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

Just two more nits I spotted, otherwise looks great!

Doc/library/test.rst Outdated Show resolved Hide resolved
Doc/library/test.rst Outdated Show resolved Hide resolved
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@JelleZijlstra JelleZijlstra added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels May 27, 2022
@JelleZijlstra JelleZijlstra merged commit 8995177 into python:main May 27, 2022
@miss-islington
Copy link
Contributor

Thanks @JelleZijlstra for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

@JelleZijlstra JelleZijlstra deleted the supportdocs branch May 27, 2022 14:16
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label May 27, 2022
@bedevere-bot
Copy link

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>
@AA-Turner AA-Turner removed the needs backport to 3.10 only security fixes label May 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants