gh-101100: Fix sphinx warnings in library/codecs.rst (#110979)

This commit is contained in:
Nikita Sobolev 2023-10-19 17:20:52 +03:00 committed by GitHub
parent e9b5399bee
commit a89708aeea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 36 additions and 34 deletions

View file

@ -520,7 +520,9 @@ The base :class:`Codec` class defines these methods which also define the
function interfaces of the stateless encoder and decoder:
.. method:: Codec.encode(input, errors='strict')
.. class:: Codec
.. method:: encode(input, errors='strict')
Encodes the object *input* and returns a tuple (output object, length consumed).
For instance, :term:`text encoding` converts
@ -538,7 +540,7 @@ function interfaces of the stateless encoder and decoder:
of the output object type in this situation.
.. method:: Codec.decode(input, errors='strict')
.. method:: decode(input, errors='strict')
Decodes the object *input* and returns a tuple (output object, length
consumed). For instance, for a :term:`text encoding`, decoding converts
@ -705,7 +707,7 @@ Stream Encoding and Decoding
The :class:`StreamWriter` and :class:`StreamReader` classes provide generic
working interfaces which can be used to implement new encoding submodules very
easily. See :mod:`encodings.utf_8` for an example of how this is done.
easily. See :mod:`!encodings.utf_8` for an example of how this is done.
.. _stream-writer-objects:
@ -895,9 +897,10 @@ The design is such that one can use the factory functions returned by the
.. class:: StreamRecoder(stream, encode, decode, Reader, Writer, errors='strict')
Creates a :class:`StreamRecoder` instance which implements a two-way conversion:
*encode* and *decode* work on the frontend — the data visible to
code calling :meth:`read` and :meth:`write`, while *Reader* and *Writer*
work on the backend — the data in *stream*.
*encode* and *decode* work on the frontend — the data visible to
code calling :meth:`~StreamReader.read` and :meth:`~StreamWriter.write`,
while *Reader* and *Writer*
work on the backend — the data in *stream*.
You can use these objects to do transparent transcodings, e.g., from Latin-1
to UTF-8 and back.
@ -1417,8 +1420,8 @@ to :class:`bytes` mappings. They are not supported by :meth:`bytes.decode`
| | quotedprintable, | quoted printable. | ``quotetabs=True`` / |
| | quoted_printable | | :meth:`quopri.decode` |
+----------------------+------------------+------------------------------+------------------------------+
| uu_codec | uu | Convert the operand using | :meth:`uu.encode` / |
| | | uuencode. | :meth:`uu.decode` |
| uu_codec | uu | Convert the operand using | |
| | | uuencode. | |
+----------------------+------------------+------------------------------+------------------------------+
| zlib_codec | zip, zlib | Compress the operand using | :meth:`zlib.compress` / |
| | | gzip. | :meth:`zlib.decompress` |

View file

@ -42,7 +42,6 @@ Doc/library/bisect.rst
Doc/library/bz2.rst
Doc/library/calendar.rst
Doc/library/cmd.rst
Doc/library/codecs.rst
Doc/library/collections.abc.rst
Doc/library/collections.rst
Doc/library/concurrent.futures.rst