Correct RequestSequence response tuple type docs #237
Conversation
The header value is passed to IRequest.setHeader() which accepts strings, not lists of strings.
Codecov Report
@@ Coverage Diff @@
## master #237 +/- ##
=======================================
Coverage 98.86% 98.86%
=======================================
Files 26 26
Lines 2285 2285
Branches 165 165
=======================================
Hits 2259 2259
Misses 14 14
Partials 12 12
Continue to review full report at Codecov.
|
| @@ -402,7 +402,7 @@ class RequestSequence(object): | |||
|
|
|||
| - ``code`` is an integer representing the HTTP status code to return. | |||
| - ``headers`` is a dictionary mapping :class:`bytes` to :class:`bytes` or | |||
| :class:`list` of :class:`bytes`. | |||
| :class:`str`. Note that the value is *not* a list. | |||
There was a problem hiding this comment.
What is the format for header items with multiple values?
There was a problem hiding this comment.
They cannot be represented in this API. :-/ You could send the semantic equivalent with a comma... *mumble mumble cookies*...
There was a problem hiding this comment.
Thanks. I wasn't able to track the usage of headers all the way through the code to verify the type but I'm guessing you did that already. I looked at some other recently accepted PRs to see if there are other contribution requirements to satisfy but I didn't see any. So, approved.
|
Thank you for the review, @exarkun! |
The header value is passed to IRequest.setHeader() which accepts strings, not lists of strings.