Commit a2f5859

authored

Merge pull request #984 from cagatay-y/master

doc: update docs to fit the move of channels from the sync module

2 parents 5640a7f + 3a26fb3 commit a2f5859Copy full SHA for a2f5859

File tree

-5

lines changed

-5

lines changed

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,8 @@`
`1`	`1`	`//! Channels`
	`2`	`+//!`
	`3`	`+//! Multi-producer, multi-consumer queues, used for message-based`
	`4`	`+//! communication. Can provide a lightweight inter-task synchronisation`
	`5`	`+//! mechanism, at the cost of some extra memory.`
`2`	`6`
`3`	`7`	`#[doc(inline)]`
`4`	`8`	`pub use async_channel::*;`

Lines changed: 3 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -129,11 +129,6 @@`
`129`	`129`	`//! to reach a point in the program, before continuing execution all`
`130`	`130`	`//! together.`
`131`	`131`	`//!`
`132`		-//! - [`channel`]: Multi-producer, multi-consumer queues, used for
`133`		`-//! message-based communication. Can provide a lightweight`
`134`		`-//! inter-task synchronisation mechanism, at the cost of some`
`135`		`-//! extra memory.`
`136`		`-//!`
`137`	`132`	//! - [`Mutex`]: Mutual exclusion mechanism, which ensures that at
`138`	`133`	`//! most one task at a time is able to access some data.`
`139`	`134`	`//!`
`@@ -142,6 +137,9 @@`
`142`	`137`	`//! writer at a time. In some cases, this can be more efficient than`
`143`	`138`	`//! a mutex.`
`144`	`139`	`//!`
	`140`	`+//! If you're looking for channels, check out`
	`141`	+//! [`async_std::channel`][crate::channel].
	`142`	`+//!`
`145`	`143`	//! [`Arc`]: struct.Arc.html
`146`	`144`	//! [`Barrier`]: struct.Barrier.html
`147`	`145`	//! [`channel`]: fn.channel.html

Comments

(0)