asyncio doc: group transport method by classes

Declare classes because they are mentionned in documentation of other functions

Doc/library/asyncio.rst

@@ -633,10 +633,15 @@ then call the transport's methods for various purposes.
 subprocess pipes.  The methods available on a transport depend on
 the transport's kind.
 
-Methods common to all transports
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. method:: BaseTransport.close(self)
+Methods common to all transports: BaseTransport
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. class:: BaseTransport
+
+   Base class for transports.
+
+   .. method:: close(self)
 
       Close the transport.  If the transport has a buffer for outgoing
       data, buffered data will be flushed asynchronously.  No more data
@@ -645,7 +650,7 @@ Methods common to all transports
       :const:`None` as its argument.
 
 
-.. method:: BaseTransport.get_extra_info(name, default=None)
+   .. method:: get_extra_info(name, default=None)
 
       Return optional transport information.  *name* is a string representing
       the piece of transport-specific information to get, *default* is the
@@ -654,37 +659,47 @@ Methods common to all transports
       This method allows transport implementations to easily expose
       channel-specific information.
 
-Methods of readable streaming transports
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. method:: ReadTransport.pause_reading()
+Methods of readable streaming transports: ReadTransport
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. class:: ReadTransport
+
+   Interface for read-only transports.
+
+   .. method:: pause_reading()
 
       Pause the receiving end of the transport.  No data will be passed to
       the protocol's :meth:`data_received` method until meth:`resume_reading`
       is called.
 
-.. method:: ReadTransport.resume_reading()
+   .. method:: resume_reading()
 
       Resume the receiving end.  The protocol's :meth:`data_received` method
       will be called once again if some data is available for reading.
 
-Methods of writable streaming transports
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. method:: WriteTransport.write(data)
+Methods of writable streaming transports: WriteTransport
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. class:: WriteTransport
+
+   Interface for write-only transports.
+
+   .. method:: write(data)
 
       Write some *data* bytes to the transport.
 
       This method does not block; it buffers the data and arranges for it
       to be sent out asynchronously.
 
-.. method:: WriteTransport.writelines(list_of_data)
+   .. method:: writelines(list_of_data)
 
       Write a list (or any iterable) of data bytes to the transport.
       This is functionally equivalent to calling :meth:`write` on each
       element yielded by the iterable, but may be implemented more efficiently.
 
-.. method:: WriteTransport.write_eof()
+   .. method:: write_eof()
 
       Close the write end of the transport after flushing buffered data.
       Data may still be received.
@@ -692,19 +707,19 @@ Methods of writable streaming transports
       This method can raise :exc:`NotImplementedError` if the transport
       (e.g. SSL) doesn't support half-closes.
 
-.. method:: WriteTransport.can_write_eof()
+   .. method:: can_write_eof()
 
       Return :const:`True` if the transport supports :meth:`write_eof`,
       :const:`False` if not.
 
-.. method:: WriteTransport.abort()
+   .. method:: abort()
 
       Close the transport immediately, without waiting for pending operations
       to complete.  Buffered data will be lost.  No more data will be received.
       The protocol's :meth:`connection_lost` method will eventually be
       called with :const:`None` as its argument.
 
-.. method:: WriteTransport.set_write_buffer_limits(high=None, low=None)
+   .. method:: set_write_buffer_limits(high=None, low=None)
 
       Set the *high*- and *low*-water limits for write flow control.
 
@@ -724,10 +739,11 @@ Methods of writable streaming transports
       reduces opportunities for doing I/O and computation
       concurrently.
 
-.. method:: WriteTransport.get_write_buffer_size()
+   .. method:: get_write_buffer_size()
 
       Return the current size of the output buffer used by the transport.
 
+
 Methods of datagram transports
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -747,20 +763,23 @@ Methods of datagram transports
    The protocol's :meth:`connection_lost` method will eventually be
    called with :const:`None` as its argument.
 
+
 Methods of subprocess transports
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. method:: BaseSubprocessTransport.get_pid()
+.. class:: BaseSubprocessTransport
+
+   .. method:: get_pid()
 
       Return the subprocess process id as an integer.
 
-.. method:: BaseSubprocessTransport.get_returncode()
+   .. method:: get_returncode()
 
       Return the subprocess returncode as an integer or :const:`None`
       if it hasn't returned, similarly to the
       :attr:`subprocess.Popen.returncode` attribute.
 
-.. method:: BaseSubprocessTransport.get_pipe_transport(fd)
+   .. method:: get_pipe_transport(fd)
 
       Return the transport for the communication pipe correspondong to the
       integer file descriptor *fd*.  The return value can be a readable or
@@ -768,12 +787,12 @@ Methods of subprocess transports
       correspond to a pipe belonging to this transport, :const:`None` is
       returned.
 
-.. method:: BaseSubprocessTransport.send_signal(signal)
+   .. method:: send_signal(signal)
 
       Send the *signal* number to the subprocess, as in
       :meth:`subprocess.Popen.send_signal`.
 
-.. method:: BaseSubprocessTransport.terminate()
+   .. method:: terminate()
 
       Ask the subprocess to stop, as in :meth:`subprocess.Popen.terminate`.
       This method is an alias for the :meth:`close` method.
@@ -782,7 +801,7 @@ Methods of subprocess transports
       On Windows, the Windows API function TerminateProcess() is called to
       stop the subprocess.
 
-.. method:: BaseSubprocessTransport.kill(self)
+   .. method:: kill(self)
 
       Kill the subprocess, as in :meth:`subprocess.Popen.kill`
 
@@ -843,12 +862,12 @@ Task functions
 
    Return ``True`` if *obj* is a coroutine object.
 
-.. function:: sleep(delay, result=None, *, loop=None)
+.. function:: sleep(delay, result=None, \*, loop=None)
 
    Create a :ref:`coroutine <coroutine>` that completes after a given time
    (in seconds).
 
-.. function:: shield(arg, *, loop=None)
+.. function:: shield(arg, \*, loop=None)
 
    Wait for a future, shielding it from cancellation.
 
@@ -879,7 +898,7 @@ Task functions
 Task
 ----
 
-.. class:: Task(coro, *, loop=None)
+.. class:: Task(coro, \*, loop=None)
 
    A coroutine wrapped in a :class:`~concurrent.futures.Future`.
 
@@ -893,7 +912,7 @@ Task
 
       Cancel the task.
 
-   .. method:: get_stack(self, *, limit=None)
+   .. method:: get_stack(self, \*, limit=None)
 
       Return the list of stack frames for this task's coroutine.
 
@@ -913,7 +932,7 @@ Task
       For reasons beyond our control, only one stack frame is returned for a
       suspended coroutine.
 
-   .. method:: print_stack(*, limit=None, file=None)
+   .. method:: print_stack(\*, limit=None, file=None)
 
       Print the stack or traceback for this task's coroutine.