summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Park <51100862+timpark0807@users.noreply.github.com>2020-07-08 01:40:33 -0700
committerCarlton Gibson <carlton.gibson@noumenal.es>2020-07-08 10:41:57 +0200
commit502349ce77a2bbf86ec33891c37f2ee9e087d520 (patch)
treed9f482cb108eb23815114861817f64be0beac430
parentb66588abe25fb54cbf1202b774cca8b27c546cbc (diff)
[3.0.x] Fixed #31739 -- Documented dependency between HttpRequest stream IO methods and body.
Backport of 060576b0abac460d72714e300aa709d1e7a87dd7 from master
-rw-r--r--docs/ref/request-response.txt6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt
index e03bc56f89..619ade110d 100644
--- a/docs/ref/request-response.txt
+++ b/docs/ref/request-response.txt
@@ -43,8 +43,10 @@ All attributes should be considered read-only, unless stated otherwise.
XML payload etc. For processing conventional form data, use
:attr:`HttpRequest.POST`.
- You can also read from an ``HttpRequest`` using a file-like interface. See
- :meth:`HttpRequest.read()`.
+ You can also read from an ``HttpRequest`` using a file-like interface with
+ :meth:`HttpRequest.read` or :meth:`HttpRequest.readline`. Accessing
+ the ``body`` attribute *after* reading the request with either of these I/O
+ stream methods will produce a ``RawPostDataException``.
.. attribute:: HttpRequest.path