[3.13] gh-53243: Document `codecs.readbuffer_encode()` (GH-136284) (#136451)

gh-53243: Document `codecs.readbuffer_encode()` (GH-136284)

Closes GH-53243
(cherry picked from commit f1dcf3c7bf90961b8d5475154d3f28cfef0a054f)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
index 962c81d599e8e8eb9accd06c5ff44f94850b47d5..33155fceb730d9625517bb8b2ae5c1e44b48a87b 100644 (file)
--- a/Doc/library/codecs.rst
+++ b/Doc/library/codecs.rst
@@ -261,6 +261,20 @@ wider range of codecs when working with binary files:
    :func:`iterencode`.
 
 
+.. function:: readbuffer_encode(buffer, errors=None, /)
+
+   Return a :class:`tuple` containing the raw bytes of *buffer*, a
+   :ref:`buffer-compatible object <bufferobjects>` or :class:`str`
+   (encoded to UTF-8 before processing), and their length in bytes.
+
+   The *errors* argument is ignored.
+
+   .. code-block:: pycon
+
+      >>> codecs.readbuffer_encode(b"Zito")
+      (b'Zito', 4)
+
+
 The module also provides the following constants which are useful for reading
 and writing to platform dependent files: