From 7c1b761964e567ee55af9c70f56b1e2e5aaefcf0 Mon Sep 17 00:00:00 2001 From: Sam El-Husseini Date: Wed, 1 Mar 2017 00:38:12 -0800 Subject: [PATCH] Swapping play builtin melody with begin melody in reference docs --- .../music/{play-builtin-melody.md => begin-melody.md} | 8 ++++---- libs/core/music.ts | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) rename docs/reference/music/{play-builtin-melody.md => begin-melody.md} (73%) diff --git a/docs/reference/music/play-builtin-melody.md b/docs/reference/music/begin-melody.md similarity index 73% rename from docs/reference/music/play-builtin-melody.md rename to docs/reference/music/begin-melody.md index 9648c84a..e869c44c 100644 --- a/docs/reference/music/play-builtin-melody.md +++ b/docs/reference/music/begin-melody.md @@ -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 @@ -12,11 +12,11 @@ music.beginMelody(music.builtInMelody(Melodies.Entertainer), MelodyOptions.Once) ### 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 -This example plays the ``Entertainer`` melody. +This example plays the ``Entertainer`` built-in melody. ```blocks music.beginMelody(music.builtInMelody(Melodies.Entertainer), MelodyOptions.Once) diff --git a/libs/core/music.ts b/libs/core/music.ts index 6bae2d8c..492fcb77 100644 --- a/libs/core/music.ts +++ b/libs/core/music.ts @@ -274,7 +274,7 @@ namespace music { * @param melody the melody array to play, eg: ['g5:1'] * @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" //% parts="headphone" export function beginMelody(melodyArray: string[], options: MelodyOptions = MelodyOptions.Once) {