Expand the docs for Router::with_state
#1580
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
davidpdrsn
force-pushed
the
expand-state-docs
branch
from
96fdce1
to
0aa71a1
Compare
davidpdrsn
commented
Nov 26, 2022
| @@ -5,10 +5,9 @@ | |||
| /// | |||
| /// See [`State`] for more details on how library authors should use this trait. | |||
| /// | |||
| /// This trait can be derived using `#[derive(axum_macros::FromRef)]`. | |||
| /// This trait can be derived using `#[derive(FromRef)]`. | |||
There was a problem hiding this comment.
The link on this didn't work for some reason but I don't actually think we need it since the macro is exported at the same path as FromRef itself.
There was a problem hiding this comment.
Well, there were no square brackets around the code block.
There was a problem hiding this comment.
Even with I couldn't get it working 🤷
jplatte
approved these changes
Nov 26, 2022
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.
We've heard from a few users who have issues with getting the state types right, especially if they're returning a router (and thus have to name the type) and calling
with_state.This expands the docs for
Router::with_stateto hopefully provide examples that help but also provide some more intuition for how things work.