Merge branch '342-stream-throttle' of github.com:Wassasin/async-std into 342-stream-throttle

src/stream/stream/mod.rs

@@ -318,6 +318,7 @@ extension_trait! {
         #[doc = r#"
             Limit the amount of items yielded per timeslice in a stream.
 
+This stream does not drop any items, but will only limit the rate at which items pass through.
             # Examples
             ```
             # fn main() { async_std::task::block_on(async {

src/stream/stream/throttle.rs

@@ -9,7 +9,13 @@ use crate::stream::Stream;
 use crate::task::{Context, Poll};
 
 pin_project! {
-    /// A stream that only yields one element once every `duration`, and applies backpressure. Does not drop any elements.
+    /// A stream that only yields one element once every `duration`.
+    ///
+    /// This `struct` is created by the [`throttle`] method on [`Stream`]. See its
+    /// documentation for more.
+    ///
+    /// [`throttle`]: trait.Stream.html#method.throttle
+    /// [`Stream`]: trait.Stream.html
     #[doc(hidden)]
     #[allow(missing_debug_implementations)]
     pub struct Throttle<S> {