Merge pull request async-rs#729 from k-nasa/fix_doc_test

Fix doc test
zhaxzhax · May 20, 2020 · 70dac51 · 70dac51
2 parents 9e6a76a + d30603a
commit 70dac51
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 35 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -138,7 +138,8 @@
 //!
 //! Call an async function from the main function:
 //!
-//! ```
+#![cfg_attr(feature = "attributes", doc = "```")]
+#![cfg_attr(not(feature = "attributes"), doc = "```ignore")]
 //! async fn say_hello() {
 //!     println!("Hello, world!");
 //! }
@@ -151,7 +152,8 @@
 //!
 //! Await two futures concurrently, and return a tuple of their output:
 //!
-//! ```
+#![cfg_attr(feature = "attributes", doc = "```")]
+#![cfg_attr(not(feature = "attributes"), doc = "```ignore")]
 //! use async_std::prelude::*;
 //!
 //! #[async_std::main]
@@ -164,7 +166,8 @@
 //!
 //! Create a UDP server that echoes back each received message to the sender:
 //!
-//! ```no_run
+#![cfg_attr(feature = "attributes", doc = "```no_run")]
+#![cfg_attr(not(feature = "attributes"), doc = "```ignore")]
 //! use async_std::net::UdpSocket;
 //!
 //! #[async_std::main]

diff --git a/src/stream/stream/max.rs b/src/stream/stream/max.rs
@@ -1,7 +1,6 @@
 use core::cmp::{Ord, Ordering};
-use core::marker::PhantomData;
-use core::pin::Pin;
 use core::future::Future;
+use core::pin::Pin;
 
 use pin_project_lite::pin_project;
 
@@ -11,29 +10,23 @@ use crate::task::{Context, Poll};
 pin_project! {
     #[doc(hidden)]
     #[allow(missing_debug_implementations)]
-    pub struct MaxFuture<S, F, T> {
+    pub struct MaxFuture<S, T> {
         #[pin]
         stream: S,
-        _compare: PhantomData<F>,
         max: Option<T>,
     }
 }
 
-impl<S, F, T> MaxFuture<S, F, T> {
+impl<S, T> MaxFuture<S, T> {
     pub(super) fn new(stream: S) -> Self {
-        Self {
-            stream,
-            _compare: PhantomData,
-            max: None,
-        }
+        Self { stream, max: None }
     }
 }
 
-impl<S, F> Future for MaxFuture<S, F, S::Item>
+impl<S> Future for MaxFuture<S, S::Item>
 where
     S: Stream,
     S::Item: Ord,
-    F: FnMut(&S::Item, &S::Item) -> Ordering,
 {
     type Output = Option<S::Item>;
 

diff --git a/src/stream/stream/min.rs b/src/stream/stream/min.rs
@@ -1,7 +1,6 @@
 use core::cmp::{Ord, Ordering};
-use core::marker::PhantomData;
-use core::pin::Pin;
 use core::future::Future;
+use core::pin::Pin;
 
 use pin_project_lite::pin_project;
 
@@ -11,29 +10,23 @@ use crate::task::{Context, Poll};
 pin_project! {
     #[doc(hidden)]
     #[allow(missing_debug_implementations)]
-    pub struct MinFuture<S, F, T> {
+    pub struct MinFuture<S, T> {
         #[pin]
         stream: S,
-        _compare: PhantomData<F>,
         min: Option<T>,
     }
 }
 
-impl<S, F, T> MinFuture<S, F, T> {
+impl<S, T> MinFuture<S, T> {
     pub(super) fn new(stream: S) -> Self {
-        Self {
-            stream,
-            _compare: PhantomData,
-            min: None,
-        }
+        Self { stream, min: None }
     }
 }
 
-impl<S, F> Future for MinFuture<S, F, S::Item>
+impl<S> Future for MinFuture<S, S::Item>
 where
     S: Stream,
     S::Item: Ord,
-    F: FnMut(&S::Item, &S::Item) -> Ordering,
 {
     type Output = Option<S::Item>;
 

diff --git a/src/stream/stream/mod.rs b/src/stream/stream/mod.rs
@@ -1011,7 +1011,7 @@ extension_trait! {
 
             # Examples
 
-            ```ignore
+            ```
             # fn main() { async_std::task::block_on(async {
             #
             use async_std::prelude::*;
@@ -1028,12 +1028,12 @@ extension_trait! {
             # }) }
             ```
         "#]
-        fn max<F>(
+        fn max(
             self,
-        ) -> impl Future<Output = Option<Self::Item>> [MaxFuture<Self, F, Self::Item>]
+        ) -> impl Future<Output = Option<Self::Item>> [MaxFuture<Self, Self::Item>]
         where
             Self: Sized,
-            F: FnMut(&Self::Item, &Self::Item) -> Ordering,
+            Self::Item: Ord,
         {
             MaxFuture::new(self)
         }
@@ -1044,7 +1044,7 @@ extension_trait! {
 
             # Examples
 
-            ```ignore
+            ```
             # fn main() { async_std::task::block_on(async {
             #
             use async_std::prelude::*;
@@ -1061,12 +1061,12 @@ extension_trait! {
             # }) }
             ```
         "#]
-        fn min<F>(
+        fn min(
             self,
-        ) -> impl Future<Output = Option<Self::Item>> [MinFuture<Self, F, Self::Item>]
+        ) -> impl Future<Output = Option<Self::Item>> [MinFuture<Self, Self::Item>]
         where
             Self: Sized,
-            F: FnMut(&Self::Item, &Self::Item) -> Ordering,
+            Self::Item: Ord,
         {
             MinFuture::new(self)
         }