Add doc aliases sleep and timeout to Timer#242
Merged
taiki-e merged 1 commit intosmol-rs:masterfrom Sep 6, 2025
Merged
Conversation
Two examples are shown in `Timer`'s docs: One example for basic _sleeping_ and one example for having a _timeout_ on a future. This adds corresponding doc aliases to `Timer`, so that this struct is easier to find with those use cases in mind.
Member
|
@janriemer could you please check why the CI is failing and provide a fix? |
Collaborator
|
CI issue was recently fixed rust-lang/rust#145952. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Two examples are shown in
Timer's docs:One example for basic sleeping and one example for having a timeout on a future.
This adds corresponding doc aliases to
Timer, so that this struct is easier to find with those use cases in mind.See doc alias feature:
https://blog.rust-lang.org/2020/11/19/Rust-1.48/#adding-search-aliases