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

doc: alias sleep to delay #3604

Merged
merged 1 commit into from Mar 10, 2021
Merged

doc: alias sleep to delay #3604

merged 1 commit into from Mar 10, 2021

Conversation

robjtede
Copy link
Sponsor Contributor

Motivation

Rustdoc search doesn't do partial matches on aliases so currently searching "delay" doesn't show the delay_for or delay_until aliases (https://docs.rs/tokio/1.3.0/tokio/?search=delay).

Solution

Alias the Sleep struct itself to "Delay" in order to increase visibility.

@Darksonn Darksonn added A-tokio Area: The main tokio crate M-time Module: tokio/time T-docs Topic: documentation labels Mar 10, 2021
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

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

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate M-time Module: tokio/time T-docs Topic: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants