summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Coghlan <ncoghlan@gmail.com>2019-01-28 01:19:02 +1000
committerNick Coghlan <ncoghlan@gmail.com>2019-01-28 01:19:08 +1000
commit0ad2ba929ae3e1f7026cf2ec557341dc8ad54b69 (patch)
tree894f417d5d8a9efcbfa1f1bcdd38d2a1d91b5af5
parente49f3ba214e395df1ac009fa86cda6826994e00a (diff)
downloadcpython-git-ncoghlan-clarify-U-mode-deprecation.tar.gz
Move 'U' entirely out of file mode tablencoghlan-clarify-U-mode-deprecation
I couldn't get the longer entry to look any good inside the table, so I moved it out to a separate paragraph after the description of the actually useful file modes.
-rw-r--r--Doc/library/functions.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index f1971537d0..cca28ff5fb 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1004,7 +1004,6 @@ are always available. They are listed here in alphabetical order.
``'b'`` binary mode
``'t'`` text mode (default)
``'+'`` open a disk file for updating (reading and writing)
- ``'U'`` :deprecated: :term:`universal newlines` is enabled by default
========= ===============================================================
The default mode is ``'r'`` (open for reading text, synonym of ``'rt'``).
@@ -1019,8 +1018,11 @@ are always available. They are listed here in alphabetical order.
first decoded using a platform-dependent encoding or using the specified
*encoding* if given.
- :term:`universal newlines` is enabled by default in text mode, but can
- be switched off with the :ref:`*newline* <open-newline-parameter>` parameter.
+ There is an additional mode character permitted, ``'U'``, which no longer
+ has any effect, and is considered deprecated. It previously enabled
+ :term:`universal newlines` in text mode, which became the default behaviour
+ in Python 3.0. Refer to the documentation of the
+ :ref:`newline <open-newline-parameter>` parameter for further details.
.. note::