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.

Sign up for GitHub

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

Jump to bottom

bpo-4928: Document NamedTemporaryFile non-deletion after SIGKILL #26198

Merged
merged 3 commits into from May 19, 2021
Merged

bpo-4928: Document NamedTemporaryFile non-deletion after SIGKILL #26198

merged 3 commits into from May 19, 2021

Conversation

catherinedevlin
Copy link
Contributor

@catherinedevlin catherinedevlin commented May 17, 2021 •
edited by bedevere-bot

Consensus on https://bugs.python.org/issue4928 seems to be that documenting the behavior is all we can really do. Submitting this as suggested wording.

https://bugs.python.org/issue4928

freddrake
freddrake requested changes May 17, 2021
View reviewed changes
Copy link
Member

@freddrake freddrake left a comment

Choose a reason for hiding this comment

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

reStructuredText shortcomings can be annoying; sorry!

Small change is needed.

Doc/library/tempfile.rst Outdated
@@ -87,6 +87,9 @@ The module defines the following user-callable items:
attribute is the underlying true file object. This file-like object can
be used in a :keyword:`with` statement, just like a normal file.

On POSIX (only), a process that is terminated abruptly with SIGKILL
cannot automatically delete :func:`NamedTemporaryFile`s it created.
Copy link
Member

Choose a reason for hiding this comment

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

As noted by the GitHub action, this reStructuredText is broken.

Suggested alternate:

   On POSIX (only), a process that is terminated abruptly with SIGKILL
   cannot automatically delete a :func:`NamedTemporaryFile` it created.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oop, pushed a different resolution before seeing your suggestion...

Thanks & sorry, would have caught this but make html is failing for me and I foolishly thought I could get by without it...

Copy link
Member

@freddrake freddrake May 17, 2021 •
edited

Choose a reason for hiding this comment

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

No worries. While I like reStructuredText better than some widely used alternatives... it has warts.

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@freddrake freddrake merged commit b3ab434 into python:main May 19, 2021
@bedevere-bot
Copy link

@freddrake: Please replace # with GH- in the commit message next time. Thanks!

@rphilips rphilips mannequin mentioned this pull request May 7, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@freddrake freddrake freddrake approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@catherinedevlin @bedevere-bot @freddrake @the-knights-who-say-ni