docs(lib): fixup markdown and grammar in doc comments#4074
Merged
Conversation
cratelyn
reviewed
May 20, 2026
| struct State { | ||
| allow_half_close: bool, | ||
| /// Re-usable HeaderMap to reduce allocating new ones. | ||
| /// Re-usable `HeaderMap` to reduce allocating new ones. |
Member
There was a problem hiding this comment.
Suggested change
| /// Re-usable `HeaderMap` to reduce allocating new ones. | |
| /// Re-usable [`HeaderMap`] to reduce allocating new ones. |
this can be a doc link
Member
Author
There was a problem hiding this comment.
Oh yea, it could be... Clippy didn't notice, and these specific comments aren't rendered into HTML 🤷
cratelyn
reviewed
May 20, 2026
Member
cratelyn
left a comment
cratelyn
left a comment
There was a problem hiding this comment.
looks like this already got merged, but these would be nice intradoc links to add.
| #[cfg(feature = "http2")] | ||
| pub(crate) struct UnboundedSender<T, U> { | ||
| /// Only used for `is_closed`, since mpsc::UnboundedSender cannot be checked. | ||
| /// Only used for `is_closed`, since `mpsc::UnboundedSender` cannot be checked. |
Member
There was a problem hiding this comment.
Suggested change
| /// Only used for `is_closed`, since `mpsc::UnboundedSender` cannot be checked. | |
| /// Only used for `is_closed`, since [`mpsc::UnboundedSender`] cannot be checked. |
| ))] | ||
| BodyWrite, | ||
| /// Error calling AsyncWrite::shutdown() | ||
| /// Error calling `AsyncWrite::shutdown()`. |
Member
There was a problem hiding this comment.
Suggested change
| /// Error calling `AsyncWrite::shutdown()`. | |
| /// Error calling [`AsyncWrite::shutdown()`]. |
| #[derive(Debug)] | ||
| pub(super) enum User { | ||
| /// Error calling user's Body::poll_data(). | ||
| /// Error calling the user's `Body::poll_data()`. |
Member
There was a problem hiding this comment.
Suggested change
| /// Error calling the user's `Body::poll_data()`. | |
| /// Error calling the user's [`Body::poll_data()`]. |
Member
Author
|
Sorry I merged so quickly, I didn't think it'd be interesting. I'll slow down 🙈 |
Member
no worries! they're just nits 😝 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
cc #4071