From 0b1b312e762ec3f51498739f2c3b24b407d2749a Mon Sep 17 00:00:00 2001 From: Abhijith Date: Fri, 21 Oct 2016 08:48:43 -0700 Subject: [PATCH] Fixing music doc issues --- docs/reference/music.md | 3 +-- docs/reference/music/beat.md | 30 ++++++++++++++++++++++++++++++ docs/reference/toc.md | 2 +- libs/core/music.ts | 2 +- 4 files changed, 33 insertions(+), 4 deletions(-) create mode 100644 docs/reference/music/beat.md diff --git a/docs/reference/music.md b/docs/reference/music.md index b770dbcd..c75c0320 100644 --- a/docs/reference/music.md +++ b/docs/reference/music.md @@ -6,7 +6,6 @@ Generation of music tones through pin ``P0``. music.playTone(0, 0); music.ringTone(0); music.rest(0); -music.noteFrequency(Note.C); music.beat(BeatFraction.Whole); music.tempo(); music.changeTempoBy(20); @@ -15,4 +14,4 @@ music.setTempo(120); ### See Also -[playTone](/reference/music/play-tone), [ringTone](/reference/music/ring-tone), [rest](/reference/music/rest), [noteFrequency](/reference/music/note-frequency), [beat](/reference/music/beat), [tempo](/reference/music/tempo), [changeTempoBy](/reference/music/change-tempo), [setTempo](/reference/music/set-tempo) +[playTone](/reference/music/play-tone), [ringTone](/reference/music/ring-tone), [rest](/reference/music/rest), [beat](/reference/music/beat), [tempo](/reference/music/tempo), [changeTempoBy](/reference/music/change-tempo-by), [setTempo](/reference/music/set-tempo) diff --git a/docs/reference/music/beat.md b/docs/reference/music/beat.md new file mode 100644 index 00000000..993fa7dd --- /dev/null +++ b/docs/reference/music/beat.md @@ -0,0 +1,30 @@ +# Beat + +Returns the duration of a beat in milli-seconds + +## Simulator + +This function only works on the micro:bit and in some browsers. + +```sig +music.beat(BeatFraction.Whole) +``` + +### Parameters + +* ``BeatFraction`` means fraction of a beat (BeatFraction.Whole, BeatFraction.Sixteenth etc) + +### Returns + +* a [number](/reference/types/number) that means the amount of milli-seconds a beat fraction represents. + + +## Example + +```blocks +music.playTone(Note.C, music.beat(BeatFraction.Quarter)) +``` + +### See also + +[play tone](/reference/music/play-tone), [ring tone](/reference/music/ring-tone), [rest](/reference/music/rest), [set tempo](/reference/music/set-tempo), [change tempo by](/reference/music/change-tempo-by) \ No newline at end of file diff --git a/docs/reference/toc.md b/docs/reference/toc.md index d2aac836..7df807db 100644 --- a/docs/reference/toc.md +++ b/docs/reference/toc.md @@ -22,7 +22,7 @@ change change-score-by -change-tempo +change-tempo-by change-var diff --git a/libs/core/music.ts b/libs/core/music.ts index 84b3a3f9..9c3e43fb 100644 --- a/libs/core/music.ts +++ b/libs/core/music.ts @@ -211,7 +211,7 @@ namespace music { * Change the tempo by the specified amount * @param bpm The change in beats per minute to the tempo, eg: 20 */ - //% help=music/change-tempo weight=39 + //% help=music/change-tempo-by weight=39 //% blockId=device_change_tempo block="change tempo by (bpm)|%value" blockGap=8 export function changeTempoBy(bpm: number): void { init();