Skip to content

Commit 276690a

Browse files
committed
Make more explicit the dependency on libstd for provided example
This could avoid newcomers to wonder why examples do not work as expected on many targets.
1 parent a468ee4 commit 276690a

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/lib.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -235,8 +235,10 @@
235235
//!
236236
//! ### `futures`
237237
//!
238-
//! An example of running two tasks concurrently. First task: blink an LED every
239-
//! second. Second task: loop back data over the serial interface.
238+
//! An example of running two tasks concurrently. First task: blink a LED every
239+
//! second. Second task: loop back data over the serial interface. The target
240+
//! must provide the `libstd` in order to be able to use `futures`, which is not
241+
//! the case for many embedded targets.
240242
//!
241243
//! ```
242244
//! extern crate embedded_hal as hal;
@@ -377,7 +379,9 @@
377379
//!
378380
//! ### `await`
379381
//!
380-
//! Same example as above but using `await!` instead of `futures`.
382+
//! Same example as above but using `await!` instead of `futures`
383+
//! (same remark concerning the availability of `libstd` on the
384+
//! target).
381385
//!
382386
//! ```
383387
//! #![feature(generator_trait)]

0 commit comments

Comments
 (0)