[doc] State clearly that open() 'file' param is "name" attr of the result#142694
Open
GrigoriiKashchenko wants to merge 2 commits intopython:mainfrom
Open
[doc] State clearly that open() 'file' param is "name" attr of the result#142694GrigoriiKashchenko wants to merge 2 commits intopython:mainfrom
GrigoriiKashchenko wants to merge 2 commits intopython:mainfrom
Conversation
[doc] Clarify that open() file param is saved as name attribute
Clarify FileIO.name and IOBase.name documentation to match functions.rst
|
The following commit authors need to sign the Contributor License Agreement: |
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
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.
Summary
Update documentation to clearly state that the
fileargument passed toopen()is stored as thenameattribute of the returned file object.Changes Made
open()functionFileIO.nameand added missingIOBase.nameattributeKey Clarifications
nameattribute stores exactly what was passed as thefileargument.. versionchanged:: 3.13directive to document the clarificationTesting
Closes gh-62734
📚 Documentation preview 📚: https://cpython-previews--142694.org.readthedocs.build/