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

Incorrect doc comment for time::driver::entry::Entry #2617

Closed
bjorn3 opened this issue Jun 13, 2020 · 4 comments
Closed

Incorrect doc comment for time::driver::entry::Entry #2617

bjorn3 opened this issue Jun 13, 2020 · 4 comments

Comments

@bjorn3
Copy link

bjorn3 commented Jun 13, 2020

/// Timer internals. Using a weak pointer allows the timer to shutdown
/// without all `Delay` instances having completed.
///
/// When `None`, the entry has not yet been linked with a timer instance.
inner: Weak<Inner>,

When None

inner is not an Option.

@blasrodri
Copy link
Contributor

When calling inner.updgrade() returns None, perhaps @bjorn3 ?

@bjorn3
Copy link
Author

bjorn3 commented Jul 17, 2020

Maybe say "When empty, ..." or something like that?

blasrodri pushed a commit to blasrodri/tokio that referenced this issue Jul 20, 2020
Applying a suggestion from tokio-rs#2617 to make the sentence more clear.
blasrodri added a commit to blasrodri/tokio that referenced this issue Jul 20, 2020
Applying a suggestion from tokio-rs#2617 to make the sentence more clear.
blasrodri added a commit to blasrodri/tokio that referenced this issue Jul 20, 2020
Applying a suggestion from tokio-rs#2617 to make the sentence more clear.
carllerche pushed a commit that referenced this issue Jul 20, 2020
Applying a suggestion from #2617 to make the sentence more clear.
@blasrodri
Copy link
Contributor

@Darksonn can we close it?

@Darksonn
Copy link
Contributor

Yes. Please add "Fixes #PRNUM" or "Closes #PRNUM" on your PRs descriptions, as github then automatically closes the issue when the PR is merged.

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

No branches or pull requests

3 participants