Skip to content

Commit

Permalink
Doc/Api note that a returning None means the end of the sound
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 24, 2024
1 parent e116660 commit 58b61f6
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/source/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
///
Expand Down

0 comments on commit 58b61f6

Please sign in to comment.