summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDave Shawley <daves@aweber.com>2017-11-17 16:37:08 -0500
committerDave Shawley <daves@aweber.com>2017-11-17 16:37:08 -0500
commit7cc3d8dc6a24975617e388e674d93251c74749f1 (patch)
tree63ee2260a501862a5fb49259241c3ff2a9771126 /docs
parent6d69f944a434a093306a8992777ba9e258d7a748 (diff)
downloadpython-requests-7cc3d8dc6a24975617e388e674d93251c74749f1.tar.gz
docs/quickstart: clarify raw response reading.
Diffstat (limited to 'docs')
-rw-r--r--docs/user/quickstart.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst
index b5288ea3..6829d592 100644
--- a/docs/user/quickstart.rst
+++ b/docs/user/quickstart.rst
@@ -189,6 +189,14 @@ download, the above is the preferred and recommended way to retrieve the
content. Note that ``chunk_size`` can be freely adjusted to a number that
may better fit your use cases.
+.. note::
+
+ An important note about using ``Response.iter_content`` versus ``Response.raw``.
+ ``Response.iter_content`` will automatically decode the ``gzip`` and ``deflate``
+ transfer-encodings. ``Response.raw`` is a raw stream of bytes -- it does not
+ transform the response content. If you really need access to the bytes as they
+ were returned, use ``Response.raw``.
+
Custom Headers
--------------