From 6a7f65894c95d41d1424f9be859adb2fe49c0bf1 Mon Sep 17 00:00:00 2001 From: Ron Hale-Evans Date: Fri, 15 Jul 2016 16:43:26 -0700 Subject: [PATCH] Added missing parameters sections --- docs/reference/input/on-gesture.md | 8 ++++++-- docs/reference/input/on-pin-pressed.md | 22 ++++++++++++++-------- 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/docs/reference/input/on-gesture.md b/docs/reference/input/on-gesture.md index 89ef7575..58b4590f 100644 --- a/docs/reference/input/on-gesture.md +++ b/docs/reference/input/on-gesture.md @@ -2,14 +2,18 @@ Start an [event handler](/reference/event-handler) (part of the program that will run when something happens) This handler works when -you do a **gesture** (like shake, tilt, or drop the micro:bit). +you do a **gesture** (like shaking the micro:bit). ```sig input.onGesture(Gesture.Shake,() => { }) ``` -## Example: random number +### Parameters + +* ``gesture`` means the way you hold or move the micro:bit. This can be `shake`, `logo up`, `logo down`, `screen up`, `screen down`, `tilt left`, `tilt right`, `free fall`, `3g`, or `6g`. + +### Example: random number This program shows a number from `0` to `9` when you shake the micro:bit. diff --git a/docs/reference/input/on-pin-pressed.md b/docs/reference/input/on-pin-pressed.md index aaaa7f11..f37c3126 100644 --- a/docs/reference/input/on-pin-pressed.md +++ b/docs/reference/input/on-pin-pressed.md @@ -1,14 +1,16 @@ # On Pin Pressed -Start an [event handler](/reference/event-handler) (part of the program -that will run when something happens, like when a button is pressed). -This handler works when you press pin `0`, `1`, or `2` together with `GND`. -When you are using this function in a web browser, click the pins on the screen instead of the ones -on the BBC micro:bit. +Start an [event handler](/reference/event-handler) (part of the +program that will run when something happens, like when a button is +pressed). This handler works when you press pin `0`, `1`, or `2` +together with `GND`. When you are using this function in a web +browser, click the pins on the screen instead of the ones on the BBC +micro:bit. -If you hold the `GND` pin with one hand and touch pin `0`, `1`, or `2` with the other, -a very small (safe) amount of electricity will flow through your body and back into -the micro:bit. This is called **completing a circuit**. It's like you're a big wire! +If you hold the `GND` pin with one hand and touch pin `0`, `1`, or `2` +with the other, a very small (safe) amount of electricity will flow +through your body and back into the micro:bit. This is called +**completing a circuit**. It's like you're a big wire! ```sig input.onPinPressed(TouchPin.P0, () => { @@ -22,6 +24,10 @@ instead of the USB cable. ## ~ +## Parameters + +* ``name`` means the pin that is being pressed, either `P0`, `P1`, or `P2` + ### Example: pin pressed counter This program counts how many times you press the `P0` pin.