Skip to content
This repository was archived by the owner on Jan 13, 2021. It is now read-only.

Commit 57cd931

Browse files
committed
Add documentation for the header map.
1 parent 2384ce0 commit 57cd931

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

docs/source/api.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ Primary HTTP/2 Interface
1919
.. autoclass:: hyper.HTTP20Push
2020
:inherited-members:
2121

22+
Headers
23+
-------
24+
25+
.. autoclass:: hyper.common.headers.HTTPHeaderMap
26+
:inherited-members:
27+
2228
Requests Transport Adapter
2329
--------------------------
2430

hyper/common/headers.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ class HTTPHeaderMap(collections.MutableMapping):
2525
- they logically contain a form of ordering
2626
2727
This data structure is an attempt to preserve all of that information
28-
while being as user-friendly as possible.
28+
while being as user-friendly as possible. It retains all of the mapping
29+
convenience methods (allowing by-name indexing), while avoiding using a
30+
dictionary for storage.
2931
3032
When iterated over, this structure returns headers in 'canonical form'.
3133
This form is a tuple, where the first entry is the header name (in

0 commit comments

Comments
 (0)