docs(server): polish server connection docs #3325
Merged
Conversation
This file contains 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
oddgrd
commented
Sep 24, 2023
Comment on lines
+11
to
+15
| //! If your server needs to support both versions, an auto-connection builder is | ||
| //! provided in the [`hyper-util`](https://github.com/hyperium/hyper-util/tree/master) | ||
| //! crate. This builder wraps the HTTP/1 and HTTP/2 connection builders from this | ||
| //! module, allowing you to set configuration for both. The builder will then check | ||
| //! the version of the incoming connection and serve it accordingly. |
There was a problem hiding this comment.
This should link to the hyper-util crates.io page when it's released. Perhaps we should open an issue for creating an auto-connection example in hyper-util as well?
seanmonstar
approved these changes
Sep 28, 2023
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.
This PR aims to address some of the tasks in #3067, specifically:
The change in service is to make it an automatic link, which was suggested by cargo doc.
The changes have been tested by running
cargo doc --features "server,http1,client,http2" --openand inspecting the docs.Feedback on phrasing or if anything should be expanded on is most welcome!