From 2aa7c91ca75fa22742d3951a6acb387ee5e0b839 Mon Sep 17 00:00:00 2001 From: Peli de Halleux Date: Tue, 5 Apr 2016 23:11:48 -0700 Subject: [PATCH] various docs updates --- docs/reference.md | 149 +----------------------------------- docs/reference/logic.md | 39 ++++++++++ docs/reference/loops.md | 26 +++++++ docs/reference/math.md | 37 +++++++++ docs/reference/variables.md | 21 +++++ 5 files changed, 127 insertions(+), 145 deletions(-) create mode 100644 docs/reference/logic.md create mode 100644 docs/reference/loops.md create mode 100644 docs/reference/math.md create mode 100644 docs/reference/variables.md diff --git a/docs/reference.md b/docs/reference.md index b0d31a4c..01e17443 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -1,10 +1,12 @@ # Reference -## micro:bit - ```namespaces basic.showString("Hello!"); input.onButtonPressed(Button.A, () => {}); +for (let i = 0;i<5;++i) {} +if (true){} +let x = 0; +Math.random(5); led.plot(0,0); radio.sendNumber(0); music.playTone(music.noteFrequency(Note.C), music.beat(BeatFraction.Whole)); @@ -13,146 +15,3 @@ pins.digitalReadPin(DigitalPin.P0); serial.writeLine("Hello!"); control.inBackground(() => {}); ``` - -## Language - -### @section full - -### ~column - -### Loops - -[for](/microbit/reference/loops/for) - -```block -for(let i = 0;i<5;i++) {} -``` - -[repeat](/microbit/reference/loops/repeat) - -![](/static/mb/blocks/contents-0.png) - -[while](/microbit/reference/loops/while) - -```block -while(true) {} -``` - -[forever](/microbit/reference/basic/forever) - -```block -basic.forever(() => {}) -``` - -### ~ - -### ~column - -### Logic - -[if](/microbit/reference/logic/if) - -```block -if(false) { -} -``` - -[Boolean](/microbit/reference/types/boolean) values: *true*; *false* - -```block -true -false -``` - -Boolean binary operators: *and* (conjunction); *or* (disjunction) - -```block -true && false; -true || false; -``` - -Boolean negation operator - -```block -!true -``` - -Comparison operators (=, !=, <, >, <=, >=) - -```block -0 == 0; -1 !- 0; -0 < 1; -1 > 0; -0 <= 1; -1 >= 0; -``` - -### Variables - -[Assign](/microbit/reference/variables/assign) (set) a variable's value - -```block -let x = 0; -``` - -Get a variable's value - -```block -let x = 0; -x; -``` - -[Change](/microbit/reference/variables/change-var) a variable's value - -```block -let x = 0; -x+=1; -``` -### ~ - -### ~column - - -### Math - -[Numeric](/microbit/reference/types/number) values: 0, 1, 2, ... - -```block -0; -1; -2; -``` - -Arithmetic binary operation (+, -, *, /) - -```block -0+1; -0-1; -1*2; -3/4; -``` - -Absolute value - -```block -Math.abs(-5); -``` - -Minimum/maximum of two values - -```block -Math.min(0, 1); -Math.max(0, 1); -``` - -Random value - -```block -Math.random(5); -``` -### Comments - -[comment](/microbit/reference/comment) - -### ~ diff --git a/docs/reference/logic.md b/docs/reference/logic.md new file mode 100644 index 00000000..f42bc6ce --- /dev/null +++ b/docs/reference/logic.md @@ -0,0 +1,39 @@ +# Logic + +[if](/microbit/reference/logic/if) + +```blocks +if(true) { +} +``` + +[Boolean](/microbit/reference/types/boolean) values: *true*; *false* + +```blocks +true +false +``` + +Boolean binary operators: *and* (conjunction); *or* (disjunction) + +```blocks +true && false; +true || false; +``` + +Boolean negation operator + +```blocks +!true +``` + +Comparison operators (=, !=, <, >, <=, >=) + +```blocks +0 == 0; +1 !- 0; +0 < 1; +1 > 0; +0 <= 1; +1 >= 0; +``` diff --git a/docs/reference/loops.md b/docs/reference/loops.md new file mode 100644 index 00000000..b55a6b2f --- /dev/null +++ b/docs/reference/loops.md @@ -0,0 +1,26 @@ +# Loops + +Repeat code. + + +[for](/reference/loops/for) + +```blocks +for(let i = 0;i<5;i++) {} +``` + +[repeat](/reference/loops/repeat) + +![](/static/mb/blocks/contents-0.png) + +[while](/reference/loops/while) + +```blocks +while(true) {} +``` + +[forever](/reference/basic/forever) + +```blocks +basic.forever(() => {}) +``` diff --git a/docs/reference/math.md b/docs/reference/math.md new file mode 100644 index 00000000..ba1610f7 --- /dev/null +++ b/docs/reference/math.md @@ -0,0 +1,37 @@ +# Math + +[Numeric](/reference/types/number) values: 0, 1, 2, ... + +```blocks +0; +1; +2; +``` + +Arithmetic binary operation (+, -, *, /) + +```blocks +0+1; +0-1; +1*2; +3/4; +``` + +Absolute value + +```blocks +Math.abs(-5); +``` + +Minimum/maximum of two values + +```blocks +Math.min(0, 1); +Math.max(0, 1); +``` + +Random value + +```blocks +Math.random(5); +``` diff --git a/docs/reference/variables.md b/docs/reference/variables.md new file mode 100644 index 00000000..2a404ba0 --- /dev/null +++ b/docs/reference/variables.md @@ -0,0 +1,21 @@ +## Variables + +[Assign](/reference/variables/assign) (set) a variable's value + +```blocks +let x = 0; +``` + +Get a variable's value + +```blocks +let x = 0; +x; +``` + +[Change](/reference/variables/change-var) a variable's value + +```blocks +let x = 0; +x+=1; +```