summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Kane <bbkane@users.noreply.github.com>2020-08-08 02:57:03 (GMT)
committerGitHub <noreply@github.com>2020-08-08 02:57:03 (GMT)
commit705f14556545699ab615ec98f707b438f9603767 (patch)
tree606463bcceaac19be2b7e6e620fcfe26b0506f46
parent102b4988b1a10d5a61034381aea15521d17c210c (diff)
downloadcpython-705f14556545699ab615ec98f707b438f9603767.zip
cpython-705f14556545699ab615ec98f707b438f9603767.tar.gz
cpython-705f14556545699ab615ec98f707b438f9603767.tar.bz2
Doc: Add a link to tutorial page from `open()` doc (GH-21737)
Adds a link to the "Reading and Writing Files" page so users can more easily discover how file handles are handled with the `with` context manager vs without it.
-rw-r--r--Doc/library/functions.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 3c36b59..43c47c1 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1055,7 +1055,8 @@ are always available. They are listed here in alphabetical order.
.. function:: open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)
Open *file* and return a corresponding :term:`file object`. If the file
- cannot be opened, an :exc:`OSError` is raised.
+ cannot be opened, an :exc:`OSError` is raised. See
+ :ref:`tut-files` for more examples of how to use this function.
*file* is a :term:`path-like object` giving the pathname (absolute or
relative to the current working directory) of the file to be opened or an