Rollup merge of #76534 - notriddle:doc-comments, r=jyn514

Add doc comments for From impls https://github.com/rust-lang/rust/issues/51430
2020-09-16 08:24:56 +02:00
parent 3a4de42a8d 8b0d0a0cad
commit 17015cd5af
2 changed files with 12 additions and 0 deletions
--- a/library/core/src/task/poll.rs
+++ b/library/core/src/task/poll.rs
@@ -112,6 +112,14 @@ impl<T, E> Poll<Option<Result<T, E>>> {

 #[stable(feature = "futures_api", since = "1.36.0")]
 impl<T> From<T> for Poll<T> {
+    /// Convert to a `Ready` variant.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// # use core::task::Poll;
+    /// assert_eq!(Poll::from(true), Poll::Ready(true));
+    /// ```
    fn from(t: T) -> Poll<T> {
        Poll::Ready(t)
    }