Add information about the meaning of Router<S>
to Router
documentation
#3235
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 meaning of
S
inRouter<S>
can be easily misunderstood,and the explanation is well-hidden in
Router::with_state()
documentation.See:
Solution
Add proper information to
Router<S>
documentation, that is much more visible to the framework user than a section inRouter::with_state(..)
documentation.