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-101100: Fix Sphinx nitpicks in library/tempfile.rst #112886

Merged
merged 2 commits into from Dec 9, 2023

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Dec 8, 2023

Doc/library/tempfile.rst Outdated Show resolved Hide resolved
Comment on lines +186 to +202
.. attribute:: TemporaryDirectory.name

The directory name can be retrieved from the :attr:`!name` attribute of the
returned object. When the returned object is used as a :term:`context manager`, the
:attr:`!name` will be assigned to the target of the :keyword:`!as` clause in
the :keyword:`with` statement, if there is one.

.. method:: TemporaryDirectory.cleanup

The directory can be explicitly cleaned up by calling the
:meth:`!cleanup` method. If *ignore_cleanup_errors* is true, any unhandled
exceptions during explicit or implicit cleanup (such as a
:exc:`PermissionError` removing open files on Windows) will be ignored,
and the remaining removable items deleted on a "best-effort" basis.
Otherwise, errors will be raised in whatever context cleanup occurs
(the :meth:`!cleanup` call, exiting the context manager, when the object
is garbage-collected or during interpreter shutdown).
Copy link
Member

Choose a reason for hiding this comment

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

👍

Before After
image image

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@AlexWaygood AlexWaygood enabled auto-merge (squash) December 9, 2023 22:01
@AlexWaygood AlexWaygood merged commit 54410e6 into python:main Dec 9, 2023
23 checks passed
@AlexWaygood AlexWaygood deleted the tempfile-nits branch December 9, 2023 22:08
@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

Sorry, @AlexWaygood, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 54410e6bd9460c9899b17132f34fd1a68b0cbdfe 3.12

@miss-islington-app
Copy link

Sorry, @AlexWaygood, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 54410e6bd9460c9899b17132f34fd1a68b0cbdfe 3.11

@bedevere-app
Copy link

bedevere-app bot commented Dec 9, 2023

GH-112910 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Dec 9, 2023
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Dec 9, 2023
…python#112886)

(cherry-picked from commit 54410e6)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Dec 9, 2023

GH-112913 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Dec 9, 2023
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Dec 9, 2023
…python#112886)

(cherry-picked from commit 54410e6)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
AlexWaygood added a commit that referenced this pull request Dec 9, 2023
) (#112910)

(cherry-picked from commit 54410e6)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
AlexWaygood added a commit that referenced this pull request Dec 9, 2023
) (#112913)

(cherry-picked from commit 54410e6)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
…n#112886)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants