docs: Refine the example comments for Router::route_service()#3410
Open
unixzii wants to merge 1 commit intotokio-rs:mainfrom
Open
docs: Refine the example comments for Router::route_service()#3410unixzii wants to merge 1 commit intotokio-rs:mainfrom
Router::route_service()#3410unixzii wants to merge 1 commit intotokio-rs:mainfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Motivation
Comments in the example code of
Router::route_service()might be confusing.axum::body::BoxBodyis not a public item and the description of whataxum::routing::any_servicedoes also seems inaccurate.Solution
The PR fixes some factual errors and clarifies the purpose of
axum::routing::any_service.This should fix #2536.