diff options
author | Robert Collins <rbtcollins@hp.com> | 2014-10-18 00:32:43 (GMT) |
---|---|---|
committer | Robert Collins <rbtcollins@hp.com> | 2014-10-18 00:32:43 (GMT) |
commit | 933430ab69b051aa35130a3cf779528faca9b6f2 (patch) | |
tree | df0df6807ba2f82cc56d034c54226a5f2628abc9 /Doc/library/functions.rst | |
parent | d20ec1b92196a01acf9bfb990329d06b4dee5c78 (diff) | |
download | cpython-933430ab69b051aa35130a3cf779528faca9b6f2.zip cpython-933430ab69b051aa35130a3cf779528faca9b6f2.tar.gz cpython-933430ab69b051aa35130a3cf779528faca9b6f2.tar.bz2 |
Issue #17401: document closefd in io.FileIO docs and add to repr
closefd was documented in the open docs but not the matching FileIO
class documented. Further, closefd, part of the core state for the
object was not shown.
In review it was noted that the open docs are a little confusing about
the interaction between closefd and paths, so tweaked them at the same
time.
Diffstat (limited to 'Doc/library/functions.rst')
-rw-r--r-- | Doc/library/functions.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index b4433bf..60fadca 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -995,8 +995,8 @@ are always available. They are listed here in alphabetical order. If *closefd* is ``False`` and a file descriptor rather than a filename was given, the underlying file descriptor will be kept open when the file is - closed. If a filename is given *closefd* has no effect and must be ``True`` - (the default). + closed. If a filename is given *closefd* must be ``True`` (the default) + otherwise an error will be raised. A custom opener can be used by passing a callable as *opener*. The underlying file descriptor for the file object is then obtained by calling *opener* with |