Skip to content

Commit

Permalink
Specify that Session.headers needs to be set to a OrderedDict in Head…
Browse files Browse the repository at this point in the history
…er Ordering docs (#6475)
  • Loading branch information
joren485 committed Aug 12, 2023
1 parent aa4cc78 commit cb7fcd7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/user/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1081,7 +1081,7 @@ Header Ordering

In unusual circumstances you may want to provide headers in an ordered manner. If you pass an ``OrderedDict`` to the ``headers`` keyword argument, that will provide the headers with an ordering. *However*, the ordering of the default headers used by Requests will be preferred, which means that if you override default headers in the ``headers`` keyword argument, they may appear out of order compared to other headers in that keyword argument.

If this is problematic, users should consider setting the default headers on a :class:`Session <requests.Session>` object, by setting :attr:`Session <requests.Session.headers>` to a custom ``OrderedDict``. That ordering will always be preferred.
If this is problematic, users should consider setting the default headers on a :class:`Session <requests.Session>` object, by setting :attr:`Session.headers <requests.Session.headers>` to a custom ``OrderedDict``. That ordering will always be preferred.

.. _timeouts:

Expand Down

0 comments on commit cb7fcd7

Please sign in to comment.