From dcc18b99d74f639ce9a0535d17b5d7197df36399 Mon Sep 17 00:00:00 2001
From: Ivan Enderlin <ivan@mnt.io>
Date: Thu, 21 Mar 2024 15:07:34 +0100
Subject: [PATCH] doc: Express what the comment says.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The comment says: “If multiple updates have happened without the
subscriber being polled, the next poll will skip all but the latest.”,
but the code shows a single `Observable::set` followed by two
`Subscriber::next`. I would personally expect the opposite.

This patch updates the example to get 2 `Observable::set` and 1
`Subscriber::next`. The rest of the example has been updated to increase
the illustration letter.
---
 eyeball/src/lib.rs | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/eyeball/src/lib.rs b/eyeball/src/lib.rs
index 665c851..13c6597 100644
--- a/eyeball/src/lib.rs
+++ b/eyeball/src/lib.rs
@@ -36,8 +36,8 @@
 //! // If multiple updates have happened without the subscriber being
 //! // polled, the next poll will skip all but the latest.
 //! Observable::set(&mut observable, "C".to_owned());
-//! assert_eq!(subscriber1.next().await, Some("C".to_owned()));
-//! assert_eq!(subscriber2.next().await, Some("C".to_owned()));
+//! Observable::set(&mut observable, "D".to_owned());
+//! assert_eq!(subscriber1.next().await, Some("D".to_owned()));
 //!
 //! // You can even obtain the value without cloning the value, by
 //! // using `.read()` (no waiting) or `.next_ref().await` (waits for
@@ -48,17 +48,17 @@
 //! // However, note that while a read guard returned by `.read()` or
 //! // `.next_ref().await` is alive, updating the observable is
 //! // blocked.
-//! Observable::set(&mut observable, "D".to_owned());
+//! Observable::set(&mut observable, "E".to_owned());
 //! {
 //!     let guard = subscriber1.next_ref().await.unwrap();
-//!     assert_eq!(*guard, "D");
+//!     assert_eq!(*guard, "E");
 //! }
 //!
 //! // The latest value is kept alive by subscribers when the
 //! // `Observable` is dropped.
 //! drop(observable);
-//! assert_eq!(subscriber1.get(), "D");
-//! assert_eq!(*subscriber2.read(), "D");
+//! assert_eq!(subscriber1.get(), "E");
+//! assert_eq!(*subscriber2.read(), "E");
 //! # }
 //! ```
 //!