Skip to content

Commit

Permalink
Revert "Minor documentation fixes related to the new CID_RESPONSE_HEA…
Browse files Browse the repository at this point in the history
…DER"
  • Loading branch information
tangent-au-deployment committed Dec 6, 2016
1 parent e6d7822 commit 069df8d
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 6 deletions.
5 changes: 0 additions & 5 deletions docs/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ 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``.
2 changes: 1 addition & 1 deletion docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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_RESPONSE_HEADER`` to ``None``.
explicitly set ``CID_REQUEST_HEADER`` to ``None``.

.. code-block:: python
Expand Down

0 comments on commit 069df8d

Please sign in to comment.