Merge pull request #11 from Polyconseil/doc/egress_header

Minor documentation fixes related to the new CID_RESPONSE_HEADER
Polyconseil · Dec 6, 2016 · e6d7822 · e6d7822
2 parents 75291ef + fbea4df
commit e6d7822
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/settings.rst b/docs/settings.rst
@@ -8,6 +8,11 @@ Settings
         The HTTP header to extract the correlation id from. Default value:
         ``X_CORRELATION_ID``
 
+    ``CID_RESPONSE_HEADER``
+        The HTTP *response* header where the correlation id will be set.
+        Default value: same name as ``CID_HEADER``. Set to ``None`` if
+        you do not want the response to include the header.
+
     ``CID_GENERATE``
         Tell the cid middleware to generate a correlation id if it doesn't
         already exist. Default value: ``False``.
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -66,7 +66,7 @@ customize it with ``CID_RESPONSE_HEADER`` in the settings:
         CID_RESPONSE_HEADER = 'X-Correlation-Id'
 
 If you don't want the header to appear in the HTTP response, you must
-explicitly set ``CID_REQUEST_HEADER`` to ``None``.
+explicitly set ``CID_RESPONSE_HEADER`` to ``None``.
 
     .. code-block:: python