summaryrefslogtreecommitdiffstats
path: root/Doc/glossary.rst
diff options
context:
space:
mode:
authorNick Coghlan <ncoghlan@gmail.com>2015-01-06 14:22:00 (GMT)
committerNick Coghlan <ncoghlan@gmail.com>2015-01-06 14:22:00 (GMT)
commitb9fdb7a452c2b6f7a628118b5f695bd061b62cc8 (patch)
tree724c4a77f635adc95e78674ce5f24e79aa391fae /Doc/glossary.rst
parentfcfed1991382f9697df574fae4115a9f815adca0 (diff)
downloadcpython-b9fdb7a452c2b6f7a628118b5f695bd061b62cc8.zip
cpython-b9fdb7a452c2b6f7a628118b5f695bd061b62cc8.tar.gz
cpython-b9fdb7a452c2b6f7a628118b5f695bd061b62cc8.tar.bz2
Issue 19548: update codecs module documentation
- clarified the distinction between text encodings and other codecs - clarified relationship with builtin open and the io module - consolidated documentation of error handlers into one section - clarified type constraints of some behaviours - added tests for some of the new statements in the docs
Diffstat (limited to 'Doc/glossary.rst')
-rw-r--r--Doc/glossary.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/glossary.rst b/Doc/glossary.rst
index 8be2e62..f4bee4e 100644
--- a/Doc/glossary.rst
+++ b/Doc/glossary.rst
@@ -820,10 +820,13 @@ Glossary
:meth:`~collections.somenamedtuple._asdict`. Examples of struct sequences
include :data:`sys.float_info` and the return value of :func:`os.stat`.
+ text encoding
+ A codec which encodes Unicode strings to bytes.
+
text file
A :term:`file object` able to read and write :class:`str` objects.
Often, a text file actually accesses a byte-oriented datastream
- and handles the text encoding automatically.
+ and handles the :term:`text encoding` automatically.
.. seealso::
A :term:`binary file` reads and write :class:`bytes` objects.