Merge pull request async-rs#984 from cagatay-y/master

doc: update docs to fit the move of channels from the sync module
s373r · Aug 31, 2021 · a2f5859 · a2f5859
2 parents 5640a7f + 3a26fb3
commit a2f5859
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git 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
@@ -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