gh-95484: Improve tempfile docs for conditions when files are removed
#95485
Conversation
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
|
The bullet list doesn't render properly, I'm actually cloning locally to debug, will push a fix soon... |
NickCrews
force-pushed
the
tempfile-docs
branch
2 times, most recently
from
d04a736 to
a24a9da
Compare
|
OK, rendering is fixed, it now looks like |
| :ref:`tempfile-examples`). On completion of the context or | ||
| destruction of the file object the temporary file will be removed | ||
| from the filesystem. | ||
| The temporary file will be removed from the filesystem when the returned |
There was a problem hiding this comment.
This sentence is not quite grammatical. I'd suggest starting with "The temporary file will be removed from the file system under the following conditions:"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Lightly edit some prose. On my initial read of the docs, I was confused about when tempfiles are deleted. I think this PR would have helped me.
Now there are two paragraphs, the first one has to do with "creating a tempfile" and the second is "deleting a tempfile". I think this is a better way of organizing things than what it used to be.
Before, an entire paragraph was about "using as a context manager", which I think is less important than "when is a tempfile deleted". The first paragraph was "what happens when you make a tempfile and also here is one way of when it is closed"
tempfiledocumentation for conditions when files are removed #95484