]> granicus.if.org Git - python/commitdiff
asyncio doc: document StreamWriter.drain()
authorVictor Stinner <victor.stinner@gmail.com>
Fri, 24 Jan 2014 17:47:26 +0000 (18:47 +0100)
committerVictor Stinner <victor.stinner@gmail.com>
Fri, 24 Jan 2014 17:47:26 +0000 (18:47 +0100)
Doc/library/asyncio-stream.rst

index f2a9f1268e6d3ff85a6c32fea6acc54c8a2d4e0f..27aae32d0f55003a3e7eb317b9d4ab4fa941a243 100644 (file)
@@ -126,9 +126,9 @@ StreamWriter
 
    .. method:: drain()
 
-      This method has an unusual return value.
+      Wait until the write buffer of the underlying transport is flushed.
 
-      The intended use is to write::
+      This method has an unusual return value. The intended use is to write::
 
           w.write(data)
           yield from w.drain()