Docs: Clarify the HeaderMap documentaion
#774
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seanmonstar
requested changes
Jul 14, 2025
src/header/map.rs
Outdated
| @@ -14,11 +14,48 @@ use super::HeaderValue; | |||
| pub use self::as_header_name::AsHeaderName; | |||
| pub use self::into_header_name::IntoHeaderName; | |||
|
|
|||
| /// A set of HTTP headers | |||
| /// The `HeaderMap` type is a specialized | |||
There was a problem hiding this comment.
Keep a vert short sentence to start helps when the type is listed on a module page, such as: https://docs.rs/http/latest/http/header/index.html
There was a problem hiding this comment.
I mean prefer an even shorter sentence, since there isn't much space. If you look at the page I linked, and scroll down to the heading "Structs", there's a list with a tiny description. Maybe something like:
A multimap container of header names and values.
There was a problem hiding this comment.
Thank you for your feedback. Now, the shortened introductory paragraph consists of only 51 characters.
Sol-Ell
force-pushed
the
clarify-header-map-doc
branch
from
d29e1a5 to
d3cc1c2
Compare
…aderMap documentation.
Sol-Ell
force-pushed
the
clarify-header-map-doc
branch
from
d3cc1c2 to
e047888
Compare
seanmonstar
approved these changes
Jul 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
HeaderMaptype in the header module.HeaderMaptype.Note: Changing the iteration order of a
HeaderMapiterator whose order is unspecified is considered a minor breaking change.Fixes: #771