Skip to content

Commit

Permalink
doc: promote an alternative headers-and-data format for publish-debug
Browse files Browse the repository at this point in the history
The option `headers-and-data` is preferred value for the debugging
mode; updating documentation to reflect this.

Signed-off-by: James Knight <james.d.knight@live.com>
  • Loading branch information
jdknight committed Jul 1, 2024
1 parent ea28688 commit 2fcbbfa
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1524,7 +1524,7 @@ Advanced publishing configuration

.. versionchanged:: 2.6

Introduce the ``headers_and_data`` option.
Introduce the ``headers-and-data`` option.

.. warning::

Expand All @@ -1544,7 +1544,7 @@ Advanced publishing configuration
- ``deprecated``: Log warnings when a deprecated API call is used
(*for development purposes*).
- ``headers``: Log requests and responses, including their headers.
- ``headers_and_data``: Log header data along with request/response bodies.
- ``headers-and-data``: Log header data along with request/response bodies.
- ``urllib3``: Enable urllib3 library debugging messages.

An example debugging configuration is as follows:
Expand Down

0 comments on commit 2fcbbfa

Please sign in to comment.