Swapping play builtin melody with begin melody in reference docs

This commit is contained in:
Sam El-Husseini 2017-03-01 00:38:12 -08:00
parent b0fddd7e72
commit 7c1b761964
2 changed files with 5 additions and 5 deletions

View File

@ -1,6 +1,6 @@
# Play Built-in Melody # Begin Melody
Play a built in musical melody through pin ``P0`` of the @boardname@. Begin playing a musical melody through pin ``P0`` of the @boardname@.
## Simulator ## Simulator
@ -12,11 +12,11 @@ music.beginMelody(music.builtInMelody(Melodies.Entertainer), MelodyOptions.Once)
### Parameters ### Parameters
* ``melody`` is the kind of built-in melody you want to play * ``melody`` is the array representation of a melody you wish to play
## Example ## Example
This example plays the ``Entertainer`` melody. This example plays the ``Entertainer`` built-in melody.
```blocks ```blocks
music.beginMelody(music.builtInMelody(Melodies.Entertainer), MelodyOptions.Once) music.beginMelody(music.builtInMelody(Melodies.Entertainer), MelodyOptions.Once)

View File

@ -274,7 +274,7 @@ namespace music {
* @param melody the melody array to play, eg: ['g5:1'] * @param melody the melody array to play, eg: ['g5:1']
* @param options melody options, once / forever, in the foreground / background * @param options melody options, once / forever, in the foreground / background
*/ */
//% help=music/start-melody weight=60 //% help=music/begin-melody weight=60
//% blockId=device_start_melody block="start|melody %melody=device_builtin_melody| repeating %options" //% blockId=device_start_melody block="start|melody %melody=device_builtin_melody| repeating %options"
//% parts="headphone" //% parts="headphone"
export function beginMelody(melodyArray: string[], options: MelodyOptions = MelodyOptions.Once) { export function beginMelody(melodyArray: string[], options: MelodyOptions = MelodyOptions.Once) {