docs(service): add HttpService documentation#3869
Merged
Merged
Conversation
this commit introduces some additional documentation to the `HttpService` trait, and the `Service` trait. notably, this commit introduces some intradoc links, so that rustdoc will render links to types like `http::Request` and `http::Response`, or to the `Body` trait. additionally, mention of `hyper-util` is added to the `Service` trait, to direct users to the glue implementations that they will likely need to interact with e.g. `tower`. Signed-off-by: katelyn martin <me+cratelyn@katelyn.world>
cratelyn
added a commit
to cratelyn/hyper-util
that referenced
this pull request
Apr 2, 2025
this commit introduces some additional documentation to the `service` submodule, and the glue types like `TowerToHyperService` and `TowerToHyperServiceFuture`. links to relevant related documentation like `hyper::service`, and the documentation of `tower::Service`. this is closely related to hyperium/hyper#3869, which proposes a similar documentation pass over `hyper`'s own `service` facilities. Signed-off-by: katelyn martin <me+cratelyn@katelyn.world>
seanmonstar
pushed a commit
to hyperium/hyper-util
that referenced
this pull request
Apr 4, 2025
this commit introduces some additional documentation to the `service` submodule, and the glue types like `TowerToHyperService` and `TowerToHyperServiceFuture`. links to relevant related documentation like `hyper::service`, and the documentation of `tower::Service`. this is closely related to hyperium/hyper#3869, which proposes a similar documentation pass over `hyper`'s own `service` facilities. Signed-off-by: katelyn martin <me+cratelyn@katelyn.world>
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.
this commit introduces some additional documentation to the
HttpServicetrait, and theServicetrait.notably, this commit introduces some intradoc links, so that rustdoc will render links to types like
http::Requestandhttp::Response, or to theBodytrait.additionally, mention of
hyper-utilis added to theServicetrait, to direct users to the glue implementations that they will likely need to interact with e.g.tower.