futures: readme, docs improvements.

2022-08-29 00:54:14 +02:00
parent 4c0f1b6354
commit 6392f06717
4 changed files with 48 additions and 8 deletions
--- a/embassy-futures/src/block_on.rs
+++ b/embassy-futures/src/block_on.rs
@ -11,6 +11,8 @@ static VTABLE: RawWakerVTable = RawWakerVTable::new(|_| RawWaker::new(ptr::null(
 /// the current thread at 100% cpu usage until the future is done. The
 /// future's `Waker` mechanism is not used.
 ///
+/// You can use this to run multiple futures concurrently with [`join`][crate::join].
+///
 /// It's suitable for systems with no or limited concurrency and without
 /// strict requirements around power consumption. For more complex use
 /// cases, prefer using a "real" executor like `embassy-executor`, which