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

Hide Unpin's documentation for Sleep #5916

Merged
merged 1 commit into from
Aug 6, 2023

Conversation

matheus-consoli
Copy link
Contributor

Motivation

Closes #5901

Hides the documentation for the Unpin implementation for Sleep.

Not as nice as marking it as !Unpin, but at least is less confusing.

Solution

Bump the pin-project-lite version to the 2.9.11, which added support to #[project(!Unpin)], in taiki-e/pin-project-lite#76.

Doc view

Not as nice as showing !Unpin, but at least it is less confusing.

image

@matheus-consoli matheus-consoli changed the title Mark Sleep as !Unpin Hide Unpin's documentation for Sleep Aug 6, 2023
@Darksonn Darksonn added T-docs Topic: documentation A-tokio Area: The main tokio crate M-time Module: tokio/time labels Aug 6, 2023
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!

@Darksonn Darksonn merged commit 51cffbb into tokio-rs:master Aug 6, 2023
@matheus-consoli matheus-consoli deleted the not-unpin-sleep branch August 6, 2023 13:24
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.

Docs prose say Sleep doesn't implement Unpin, but sidebar does
2 participants