Document compression

nbraem · Jan 20, 2015 · 06afe9f · 06afe9f
1 parent 1493976
commit 06afe9f
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/docs/web_reference.rst b/docs/web_reference.rst
@@ -140,6 +140,29 @@ first positional parameter.
 
       .. versionadded:: 0.15
 
+   .. attribute:: compression
+
+      Read-only :class:`bool` property, ``True`` if compression is enabled.
+
+      ``False`` by default.
+
+      .. versionadded:: 0.14
+
+      .. seealso:: :meth:`enable_compression`
+
+   .. method:: enable_compression(force=False)
+
+      Enable compression.
+
+      When *force* is ``False`` (default) compression is used only
+      when *deflate* is in *Accept-Encoding* request's header.
+
+      *Accept-Encoding* is not checked if *force* is ``True``.
+
+      .. versionadded:: 0.14
+
+      .. seealso:: :attr:`compression`
+
    .. attribute:: payload
 
       A :class:`~aiohttp.streams.FlowControlStreamReader` instance,