summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZachary Ware <zachary.ware@gmail.com>2017-05-24 21:11:01 (GMT)
committerGitHub <noreply@github.com>2017-05-24 21:11:01 (GMT)
commita2a9984a278d2ee945e91ce13e000e571794fc24 (patch)
treed4902448eb3ed1a7917d763490645701b0c755df
parentc3454f0e79b35fb81b0426cfac4b801d4495b8ea (diff)
downloadcpython-a2a9984a278d2ee945e91ce13e000e571794fc24.zip
cpython-a2a9984a278d2ee945e91ce13e000e571794fc24.tar.gz
cpython-a2a9984a278d2ee945e91ce13e000e571794fc24.tar.bz2
[3.6] bpo-30160: Clarify intended usage of wfile (gh-1300) (GH-1793)
The library does not enforce compliance with the HTTP protocol, so violations are not technically disallowed. Extend the stream's description to avoid suggesting that intentional protocol violations are not supported. (cherry picked from commit a083c8e)
-rw-r--r--Doc/library/http.server.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/http.server.rst b/Doc/library/http.server.rst
index fb5c1df..b29020b 100644
--- a/Doc/library/http.server.rst
+++ b/Doc/library/http.server.rst
@@ -105,7 +105,8 @@ of which this module provides three different variants:
Contains the output stream for writing a response back to the
client. Proper adherence to the HTTP protocol must be used when writing to
- this stream.
+ this stream in order to achieve successful interoperation with HTTP
+ clients.
.. versionchanged:: 3.6
This is an :class:`io.BufferedIOBase` stream.