From 5178c24cf4b0fcf4ac25f76b5456cf96e745a2be Mon Sep 17 00:00:00 2001
From: Adam Simpkins <adam@adamsimpkins.net>
Date: Tue, 9 Apr 2024 11:00:44 -0700
Subject: [PATCH] Fix embassy-futures test failure
Running `cargo test` in embassy-futures was failing. The `no_run` tag
on this doc example caused it to still try and compile this example,
just not run it, and compilation failed. This updates the example so
that it can successfully compile and run.
---
embassy-futures/src/yield_now.rs | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/embassy-futures/src/yield_now.rs b/embassy-futures/src/yield_now.rs
index bb3c67d17..4d4e535f2 100644
--- a/embassy-futures/src/yield_now.rs
+++ b/embassy-futures/src/yield_now.rs
@@ -9,10 +9,16 @@ use core::task::{Context, Poll};
/// hold, while still allowing other tasks to run concurrently (not monopolizing
/// the executor thread).
///
-/// ```rust,no_run
+/// ```rust
+/// # use embassy_futures::{block_on, yield_now};
+/// # async fn test_fn() {
+/// # let mut iter_count: u32 = 0;
+/// # let mut some_condition = || { iter_count += 1; iter_count > 10 };
/// while !some_condition() {
/// yield_now().await;
/// }
+/// # }
+/// # block_on(test_fn());
/// ```
///
/// The downside is this will spin in a busy loop, using 100% of the CPU, while