[Python-checkins] Doc: Add a link to tutorial page from `open()` doc (GH-21737)

Miss Islington (bot) webhook-mailer at python.org
Fri Aug 7 23:05:08 EDT 2020

commit: de5de413e7f03e9cdcaf0cf96b13f4fe6bd5ccb6
branch: 3.8
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2020-08-07T20:05:04-07:00

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.
(cherry picked from commit 705f14556545699ab615ec98f707b438f9603767)

Co-authored-by: Benjamin Kane <bbkane at users.noreply.github.com>

M Doc/library/functions.rst

diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 0f7df0e5e9107..8cf755a0e6b38 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1035,7 +1035,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

More information about the Python-checkins mailing list