From 58b61f66ffa138aadfcf103e15c31fd546132bbd Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
 <41898282+github-actions[bot]@users.noreply.github.com>
Date: Tue, 24 Sep 2024 23:35:06 +0200
Subject: [PATCH] Doc/Api note that a  returning None means the end of the
 sound

---
 src/source/mod.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/source/mod.rs b/src/source/mod.rs
index 42c43ed6..1e85270b 100644
--- a/src/source/mod.rs
+++ b/src/source/mod.rs
@@ -114,7 +114,8 @@ mod zero;
 /// - The number of channels can be retrieved with `channels`.
 /// - The frequency can be retrieved with `sample_rate`.
 /// - The list of values can be retrieved by iterating on the source. The `Source` trait requires
-///   that the `Iterator` trait be implemented as well.
+///   that the `Iterator` trait be implemented as well. When a `Source` returns None the
+///   sound has ended.
 ///
 /// # Frames
 ///