-
Notifications
You must be signed in to change notification settings - Fork 291
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
HeaderMap docs show using a string value #71
Comments
It looks like this will be fixed as part of #86? |
No, the docs still show using a |
Docs can be fixed post 0.1, so I will remove the milestone. |
carllerche
added a commit
that referenced
this issue
Aug 16, 2017
This is pretty much done. Glancing through, it looks like |
seanmonstar
added
A-headers
Area: HTTP headers
E-easy
Effort: easy. Start here :D
labels
Oct 18, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The documentation of
HeaderMap
shows using strings for values, which works in the doc tests becauseHeaderMap<T>
is generic over the value. However, if people try to use the same examples in real code, it won't work, becauseRequest
andResponse
both useHeaderMap<HeaderValue>
. The docs should probably be updated to show usingHeaderValue
s.I also kind of wonder if the generic
T
will cause problems elsewhere. If someone just needs to view some headers, and writes&HeaderMap
, and sees the complaint about a missing generic, will they easily be able to determine it should be&HeaderMap<HeaderValue
?Should we export a type alias instead?
The text was updated successfully, but these errors were encountered: