mark versionadded for recv_into

Author: minrk

zmq/backend/cffi/socket.py

@@ -338,43 +338,6 @@ def recv(self, flags=0, copy=True, track=False):
         return _bytes
 
     def recv_into(self, buffer, /, *, nbytes: int = 0, flags: int = 0) -> int:
-        """
-        Receive up to nbytes bytes from the socket,
-        storing the data into a buffer rather than allocating a new Frame.
-
-        A message frame can be discarded by receiving into an empty buffer::
-
-            sock.recv_into(bytearray())
-
-        Parameters
-        ----------
-        buffer : memoryview
-            Any object providing the buffer interface (i.e. `memoryview(buffer)` works),
-            where the memoryview is contiguous and writable.
-        nbytes: int, default=0
-            The maximum number of bytes to receive.
-            If nbytes is not specified (or 0), receive up to the size available in the given buffer.
-            If the next frame is larger than this, the frame will be truncated and message content discarded.
-        flags: int, default=0
-            See `socket.recv`
-
-        Returns
-        -------
-        bytes_received: int
-            Returns the number of bytes received.
-            This is always the size of the received frame.
-            If the returned `bytes_received` is larger than `nbytes` (or size of `buffer` if `nbytes=0`),
-            the message has been truncated and the rest of the frame discarded.
-            Truncated data cannot be recovered.
-
-        Raises
-        ------
-        ZMQError
-            for any of the reasons `zmq_recv` might fail.
-        ValueError
-            for invalid inputs, such as readonly or not contiguous buffers,
-            or invalid nbytes.
-        """
         view = memoryview(buffer)
         if not view.contiguous:
             raise ValueError("Can only recv_into contiguous buffers")

zmq/backend/cython/_zmq.py

@@ -1201,10 +1201,12 @@ def recv_into(self, buffer, /, *, nbytes=0, flags=0) -> C.int:
         Receive up to nbytes bytes from the socket,
         storing the data into a buffer rather than allocating a new Frame.
 
-        A message frame can be discarded by receiving into an empty buffer::
+        The next message frame can be discarded by receiving into an empty buffer::
 
             sock.recv_into(bytearray())
 
+        .. versionadded:: 26.4
+
         Parameters
         ----------
         buffer : memoryview