Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add information about the meaning of Router<S> to Router documentation #3235

Merged
merged 4 commits into from
Feb 27, 2025

Conversation

wkordalski
Copy link
Contributor

@wkordalski wkordalski commented Feb 25, 2025

Motivation

The meaning of S in Router<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 in Router::with_state(..) documentation.

Copy link
Collaborator

@mladedav mladedav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clarification.

Co-authored-by: David Mládek <[email protected]>
@jplatte jplatte enabled auto-merge (squash) February 27, 2025 20:10
@jplatte jplatte merged commit 2a5189e into tokio-rs:main Feb 27, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants