From 3a26fb32dcb1775afa93b34e3c79f5ffe9c035d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=87a=C4=9Fatay=20Yi=C4=9Fit=20=C5=9Eahin?= Date: Mon, 30 Aug 2021 17:51:40 +0300 Subject: [PATCH] doc: update docs to fit the move of channels from the sync module fixes #983 --- src/channel.rs | 4 ++++ src/sync/mod.rs | 8 +++----- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/src/channel.rs b/src/channel.rs index 72938892..8eb30a42 100644 --- a/src/channel.rs +++ b/src/channel.rs @@ -1,4 +1,8 @@ //! Channels +//! +//! Multi-producer, multi-consumer queues, used for message-based +//! communication. Can provide a lightweight inter-task synchronisation +//! mechanism, at the cost of some extra memory. #[doc(inline)] pub use async_channel::*; diff --git a/src/sync/mod.rs b/src/sync/mod.rs index 864e781d..35203a6e 100644 --- a/src/sync/mod.rs +++ b/src/sync/mod.rs @@ -129,11 +129,6 @@ //! to reach a point in the program, before continuing execution all //! together. //! -//! - [`channel`]: Multi-producer, multi-consumer queues, used for -//! message-based communication. Can provide a lightweight -//! inter-task synchronisation mechanism, at the cost of some -//! extra memory. -//! //! - [`Mutex`]: Mutual exclusion mechanism, which ensures that at //! most one task at a time is able to access some data. //! @@ -142,6 +137,9 @@ //! writer at a time. In some cases, this can be more efficient than //! a mutex. //! +//! If you're looking for channels, check out +//! [`async_std::channel`][crate::channel]. +//! //! [`Arc`]: struct.Arc.html //! [`Barrier`]: struct.Barrier.html //! [`channel`]: fn.channel.html