Document automatic decompression.

Lukasa · Lukasa · commit b6f5aeefb459 · 2014-02-20T19:51:36.000Z
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -10,11 +10,13 @@ X.X.X (XXXX-XX-XX)
 - Stopped HTTP/2.0 special headers appearing in the response headers.
   (`Issue #16`_)
 - `HTTP20Connection` objects are now context managers. (`Issue #13`_)
+- Response bodies are automatically decompressed. (`Issue #20`_)
 
 
 .. _Issue #12: https://github.com/Lukasa/hyper/issues/12
 .. _Issue #16: https://github.com/Lukasa/hyper/issues/16
 .. _Issue #13: https://github.com/Lukasa/hyper/issues/13
+.. _Issue #20: https://github.com/Lukasa/hyper/issues/20
 
 0.0.1 (2014-02-11)
 ++++++++++++++++++
diff --git a/docs/source/advanced.rst b/docs/source/advanced.rst
@@ -33,3 +33,16 @@ a 'streaming' upload by providing a file-like object to the 'data' parameter.
 This will cause ``hyper`` to read the data in 1kB at a time and send it to the
 remote server. You _must_ set an accurate Content-Length header when you do
 this, as ``hyper`` won't set it for you.
+
+Content Decompression
+---------------------
+
+In HTTP/2.0 it's mandatory that user-agents support receiving responses that
+have their bodies compressed. As demonstrated in the quickstart guide,
+``hyper`` transparently implements this decompression, meaning that responses
+are automatically decompressed for you. If you don't want this to happen,
+you can turn it off by passing the ``decode_content`` parameter to
+:meth:`read() <hyper.HTTP20Response.read>`, like this::
+
+    >>> resp.read(decode_content=False)
+    b'\xc9...'
diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
@@ -72,13 +72,10 @@ Once you've got the data, things continue to behave exactly like
     >>> resp.status
     200
 
-Based on the ``Content-Encoding`` header, we know that the body is compressed.
-Currently, ``hyper`` doesn't support decoding that body, so you'll need to do
-it yourself::
+We know that Twitter has compressed the response body. ``hyper`` will
+automatically decompress that body for you, no input required::
 
     >>> body = resp.read()
-    >>> import zlib
-    >>> zlib.decompress(body)
     b'<!DOCTYPE html>\n<!--[if IE 8]><html clas ....
 
 That's all it takes.
