Address issue 18229 - Explain http.server.BaseHTTPRequestHandler's .headers attribute...

Initial patch by Caelyn McAulay.

diff --git a/Doc/library/http.server.rst b/Doc/library/http.server.rst
index dd19fb4bfbcddb82238ca8ef5e60c61bc730ed9c..0d8e7fe6c77c3aa3f1295d56180d656e23900286 100644 (file)
--- a/Doc/library/http.server.rst
+++ b/Doc/library/http.server.rst
@@ -81,7 +81,10 @@ of which this module provides three different variants:
 
       Holds an instance of the class specified by the :attr:`MessageClass` class
       variable. This instance parses and manages the headers in the HTTP
-      request.
+      request. The :func:`~http.client.parse_headers` function from
+      :mod:`http.client` is used to parse the headers and it requires that the
+      HTTP request provide a valid :rfc:`2822` style header.
+
 
    .. attribute:: rfile