fix(docs): Clarify nested router fallbacks in CHANGELOG.md #1581
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
LeoniePhiline
changed the title
LeoniePhiline
commented
Nov 26, 2022
| @@ -24,7 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 | |||
| // this would panic in 0.5 but in 0.6 it just works | |||
| // | |||
| // requests starting with `/api` but not handled by `api_router` | |||
| // will go to `/api_fallback` | |||
| // will go to `api_fallback` | |||
There was a problem hiding this comment.
Reasoning:
api_fallbackis a handler, not a path.
LeoniePhiline
commented
Nov 26, 2022
| @@ -37,7 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 | |||
|
|
|||
| let app = Router::new() | |||
| .nest("/api", api_router) | |||
| // `api_fallback` will inherit this fallback | |||
| // `api_router` will inherit this fallback | |||
There was a problem hiding this comment.
Reasoning:
api_fallbackdoes not exist here.- The
Routerapi_routerinherits theapp_fallbackhandler as fallback.
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.
Motivation
The first subsection of the
CHANGELOG.md's axum 0.6 section is somewhat unclear.Solution
This PR clarifies the explanation of nested routers' fallback routes in the ChangeLog entry for axum 0.6.