bpo-32843: Additional changes to test.support docs by csabella · Pull Request #5774 · python/cpython

csabella · 2018-02-20T16:19:27Z

https://bugs.python.org/issue32843

vstinner

LGTM. Just the disable_faulthandler() doc is wrong.

vstinner · 2019-05-17T18:27:54Z

Doc/library/test.rst

+   A context manager that uses ``sys.__stderr__`` instead of
+   :data:`sys.stderr`, since :mod:`test.regrtest` replaces :data:`sys.stderr`
+   with a :class:`io.StringIO` which has no file descriptor when a test is run
+   with ``-W/--verbose3``.


Well, no. The purpose of this context manager is to disable temporarily faulthandler.

matrixise · 2019-09-11T13:42:38Z

@csabella Could you update your PR? Thanks

JulienPalard · 2019-09-13T16:05:46Z

Doc/library/test.rst

 .. data:: FS_NONASCII

-   A non-ASCII character encodable by :func:`os.fsencode`.
+   A non-ASCII character encodable by :func:`os.fsencode`.  The function


"The function" may be a bit opaque here. Maybe replace The function by Choosen at import time (which breaks the rest of the sentence)?

I think the extra text is unnecessary here; we don't need to explain how the object is derived, only what it's for.

JulienPalard · 2019-09-13T16:10:45Z

Doc/library/test.rst

 .. data:: TESTFN_UNICODE

-    Set to a non-ASCII name for a temporary file.
+    Set to a non-ASCII filename containing several unicode characters.


Looks redundent to me (non-ASCII and several unicode). Also an "unicode character" may be one in the ASCII table.

Maybe "Set to a non-ASCII filename." is enough? In contrast this one is not tested against being fsencodable.

JulienPalard · 2019-09-13T16:27:38Z

Doc/library/test.rst


-   This makes a copy of :data:`sys.path`, appends any directories given
-   as positional arguments, then reverts :data:`sys.path` to the copied
+   This makes a copy of ``sys.path``, appends any directories given


:data:`sys.path` was creating a link to it, ``sys.path`` won't, why changing it? (multiple occurrences following)

bedevere-bot · 2019-09-13T16:28:44Z

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

JulienPalard · 2020-11-03T22:41:46Z

@csabella Hi Cheryl, long time no see, what about this PR? It accumulated a few conflicts :-(

JelleZijlstra

This unfortunately has a lot of conflicts now, enough that it's easier to start from scratch. I'll close this and open a new

JelleZijlstra · 2022-05-08T21:53:38Z

Doc/library/test.rst

 The :mod:`test.support` module defines the following constants:

+
+.. data:: HOST


This no longer exists on main

JelleZijlstra · 2022-05-08T21:57:10Z

Doc/library/test.rst

 .. data:: FS_NONASCII

-   A non-ASCII character encodable by :func:`os.fsencode`.
+   A non-ASCII character encodable by :func:`os.fsencode`.  The function


I think the extra text is unnecessary here; we don't need to explain how the object is derived, only what it's for.

JelleZijlstra · 2022-05-08T22:02:00Z

Doc/library/test.rst

   Set to :data:`sys.maxsize` for big memory tests.


-.. data:: max_memuse


I think it's better to keep this documented for symmetry with real_max_memuse.

JelleZijlstra · 2022-05-08T22:20:15Z

Doc/library/test.rst



-.. function:: strip_python_strerr(stderr)
+.. function:: strip_python_stderr(stderr)


This was removed in 3.9.0a2

@csabella

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>

@csabella

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> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

@csabella

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>

@csabella

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>

@csabella

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>

@csabella

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>

bpo-32843: Additional changes to test.support docs

58094fa

bedevere-bot added the awaiting review label Feb 20, 2018

the-knights-who-say-ni added the CLA signed label Feb 20, 2018

matrixise added the docs Documentation in the Doc dir label May 15, 2019

matrixise requested a review from vstinner May 15, 2019 21:19

vstinner approved these changes May 17, 2019

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels May 17, 2019

JulienPalard requested changes Sep 13, 2019

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting merge labels Sep 13, 2019

JulienPalard added the skip news label Sep 13, 2019

JelleZijlstra reviewed May 8, 2022

View reviewed changes

JelleZijlstra closed this May 8, 2022

JelleZijlstra mentioned this pull request May 8, 2022

gh-77024: test.support: Improve documentation #92513

Merged

miss-islington mentioned this pull request May 27, 2022

[3.11] gh-77024: test.support: Improve documentation (GH-92513) #93291

Merged

miss-islington mentioned this pull request May 27, 2022

[3.10] gh-77024: test.support: Improve documentation (GH-92513) #93292

Merged

csabella mentioned this pull request Apr 10, 2022

More revisions to test.support docs #77024

Closed

		The :mod:`test.support` module defines the following constants:


		.. data:: HOST

		Set to :data:`sys.maxsize` for big memory tests.


		.. data:: max_memuse



		.. function:: strip_python_strerr(stderr)
		.. function:: strip_python_stderr(stderr)

Uh oh!

Conversation

csabella commented Feb 20, 2018 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matrixise commented Sep 11, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bedevere-bot commented Sep 13, 2019

Uh oh!

JulienPalard commented Nov 3, 2020

Uh oh!

JelleZijlstra left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

csabella commented Feb 20, 2018 •

edited by bedevere-bot

Loading