Skip to content

Commit

Permalink
documentation fixes; return values of play functions made more regular
Browse files Browse the repository at this point in the history
  • Loading branch information
martin-henz committed Sep 10, 2023
1 parent f2c1e5f commit 5f93923
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/bundles/stereo_sound/functions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -337,13 +337,13 @@ export function is_sound(x: any): boolean {
/**
* Plays the given Wave using the computer’s sound device, for the duration
* given in seconds.
* The sound is only played if no other sounds are currently being played.
* The Sound is only played if no other Sounds are currently being played.
*
* @param wave the wave function to play, starting at 0
* @return the given sound
* @return the given Sound
* @example play_wave(t => math_sin(t * 3000), 5);
*/
export function play_wave(wave: Wave, duration: number): AudioPlayed {
export function play_wave(wave: Wave, duration: number): Sound {
return play(make_sound(wave, duration));
}

Expand Down

0 comments on commit 5f93923

Please sign in to comment.