Skip to content

Commit 7a10534

Browse files
authored
Merge pull request #591 from istudyatuni/clarify-docs
clarify docs about dropping stream
2 parents 3a23d2c + 2427bde commit 7a10534

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/lib.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
//! use std::io::BufReader;
2121
//! use rodio::{Decoder, OutputStream, source::Source};
2222
//!
23-
//! // Get an output stream handle to the default physical sound device
23+
//! // Get an output stream handle to the default physical sound device.
24+
//! // Note that no sound will be played if _stream is dropped
2425
//! let (_stream, stream_handle) = OutputStream::try_default().unwrap();
2526
//! // Load a sound from a file, using a path relative to Cargo.toml
2627
//! let file = BufReader::new(File::open("examples/music.ogg").unwrap());

0 commit comments

Comments
 (0)