From 534e3723d2519af50e3d0679de5ebd54fb02e0f3 Mon Sep 17 00:00:00 2001 From: Ron Hale-Evans Date: Mon, 18 Jul 2016 15:51:28 -0700 Subject: [PATCH] Finishing fixing parameters --- docs/reference/pins/analog-read-pin.md | 2 +- docs/reference/pins/analog-set-period.md | 4 ++-- docs/reference/pins/analog-write-pin.md | 4 ++-- docs/reference/pins/digital-read-pin.md | 2 +- docs/reference/pins/digital-write-pin.md | 4 ++-- docs/reference/pins/map.md | 8 ++++---- docs/reference/pins/on-pulsed.md | 4 ++-- docs/reference/pins/servo-set-pulse.md | 4 ++-- docs/reference/pins/servo-write-pin.md | 4 ++-- docs/reference/pins/set-pull.md | 4 ++-- 10 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/reference/pins/analog-read-pin.md b/docs/reference/pins/analog-read-pin.md index 45e9bd3c..c9b87526 100644 --- a/docs/reference/pins/analog-read-pin.md +++ b/docs/reference/pins/analog-read-pin.md @@ -9,7 +9,7 @@ pins.analogReadPin(AnalogPin.P0) ### Parameters -* a [string](/reference/types/string) with the name of the pin +* ``name`` is a [string](/reference/types/string) with the name of the pin you say (`P0` through `P4`, or `P10`) ### Returns diff --git a/docs/reference/pins/analog-set-period.md b/docs/reference/pins/analog-set-period.md index e16dd7b8..d4c7163e 100644 --- a/docs/reference/pins/analog-set-period.md +++ b/docs/reference/pins/analog-set-period.md @@ -10,8 +10,8 @@ pins.analogSetPeriod(AnalogPin.P0, 20000) ### Parameters -* `pin`: a [string](/reference/types/string) that specifies the pin to configure (`P0` through `P4`, or `P10`) -* `μs`: a [number](/reference/types/number) that specifies the analog period in microseconds. +* ``name``: a [string](/reference/types/string) that specifies the pin to configure (`P0` through `P4`, or `P10`) +* ``micros``: a [number](/reference/types/number) that specifies the analog period in microseconds. The following code first sets `P0` to analog with **analog write pin**, and then sets the PWM period of `P0` to 20,000 microseconds. diff --git a/docs/reference/pins/analog-write-pin.md b/docs/reference/pins/analog-write-pin.md index 3c4d3f1a..c3b1245e 100644 --- a/docs/reference/pins/analog-write-pin.md +++ b/docs/reference/pins/analog-write-pin.md @@ -9,8 +9,8 @@ pins.analogWritePin(AnalogPin.P0, 400) ### Parameters -* a [string](/reference/types/string) that is the pin name you say (`P0` through `P4`, or `P10`) -* a [number](/reference/types/number) from `0` through `1023` +* ``name`` is a [string](/reference/types/string) that is the pin name you say (`P0` through `P4`, or `P10`) +* ``value`` is a [number](/reference/types/number) from `0` through `1023` ### Example diff --git a/docs/reference/pins/digital-read-pin.md b/docs/reference/pins/digital-read-pin.md index baa98dbe..21e7f33f 100644 --- a/docs/reference/pins/digital-read-pin.md +++ b/docs/reference/pins/digital-read-pin.md @@ -16,7 +16,7 @@ Please read the [page about pins](/device/pins) carefully. ### Parameters -* a [string](/reference/types/string) that stores the name of the pin (``P0``, ``P1``, or ``P2``, up through ``P20``) +* ``name`` is a [string](/reference/types/string) that stores the name of the pin (``P0``, ``P1``, or ``P2``, up through ``P20``) ### Returns diff --git a/docs/reference/pins/digital-write-pin.md b/docs/reference/pins/digital-write-pin.md index 72771996..4c521ade 100644 --- a/docs/reference/pins/digital-write-pin.md +++ b/docs/reference/pins/digital-write-pin.md @@ -16,8 +16,8 @@ Please read the [page about pins](/device/pins) carefully. ### Parameters -* a [string](/reference/types/string) that stores the name of the pin (``P0``, ``P1``, or ``P2``, up through ``P20``) -* a [number](/reference/types/number) that can be either `0` or `1` +* ``name`` is a [string](/reference/types/string) that stores the name of the pin (``P0``, ``P1``, or ``P2``, up through ``P20``) +* ``value`` is a [number](/reference/types/number) that can be either `0` or `1` ### Example: football score keeper diff --git a/docs/reference/pins/map.md b/docs/reference/pins/map.md index 04c152b7..d2b22cf2 100644 --- a/docs/reference/pins/map.md +++ b/docs/reference/pins/map.md @@ -17,10 +17,10 @@ pins.map(0, 0, 4, 0, 1023); ### Parameters * ``value``: a [number](/reference/types/number) that specifies the value to map -* ``from low``: a [number](/reference/types/number) that specifies the lower bound of the origin interval -* ``from high``: a [number](/reference/types/number) that specifies the upper bound of the origin interval -* ``to low``: a [number](/reference/types/number) that specifies the lower bound of the target interval -* ``to high``: a [number](/reference/types/number) that specifies the upper bound of the target interval +* ``fromLow``: a [number](/reference/types/number) that specifies the lower bound of the origin interval +* ``fromHigh``: a [number](/reference/types/number) that specifies the upper bound of the origin interval +* ``toLow``: a [number](/reference/types/number) that specifies the lower bound of the target interval +* ``toHigh``: a [number](/reference/types/number) that specifies the upper bound of the target interval ## Example diff --git a/docs/reference/pins/on-pulsed.md b/docs/reference/pins/on-pulsed.md index d33a23fe..6e064eeb 100644 --- a/docs/reference/pins/on-pulsed.md +++ b/docs/reference/pins/on-pulsed.md @@ -10,8 +10,8 @@ pins.onPulsed(DigitalPin.P0, PulseValue.High, () => { }); ### Parameters -* ``pin``: The micro:bit hardware pin to configure (``P0`` through ``P20``) -* ``pulsed``: Which state will cause the associated block to execute (**High** or **Low**) +* ``name``: The micro:bit hardware pin to configure (``P0`` through ``P20``) +* ``pulse``: Which state will cause the associated block to execute (**High** or **Low**) ### Example diff --git a/docs/reference/pins/servo-set-pulse.md b/docs/reference/pins/servo-set-pulse.md index c3cb1ae3..65c1c81f 100644 --- a/docs/reference/pins/servo-set-pulse.md +++ b/docs/reference/pins/servo-set-pulse.md @@ -9,8 +9,8 @@ pins.servoSetPulse(AnalogPin.P1, 1500) ### Parameters -* `pin`: a [string](/reference/types/string) that specifies the pin to configure (`P0` through `P4`, or `P10`) -* `μs`: a [number](/reference/types/number) that specifies the analog period in microseconds. +* ``name``: a [string](/reference/types/string) that specifies the pin to configure (`P0` through `P4`, or `P10`) +* ``micros``: a [number](/reference/types/number) that specifies the analog period in microseconds. ### Example diff --git a/docs/reference/pins/servo-write-pin.md b/docs/reference/pins/servo-write-pin.md index 949b2af1..e13864cc 100644 --- a/docs/reference/pins/servo-write-pin.md +++ b/docs/reference/pins/servo-write-pin.md @@ -14,8 +14,8 @@ pins.servoWritePin(AnalogPin.P0, 180) ### Parameters -* a [string](/reference/types/string) that specifies the pin name (`P0` through `P4`, or `P10`) -* a [number](/reference/types/number) from `0` through `180` +* ``name``: a [string](/reference/types/string) that specifies the pin name (`P0` through `P4`, or `P10`) +* ``value``: a [number](/reference/types/number) from `0` through `180` ### Examples diff --git a/docs/reference/pins/set-pull.md b/docs/reference/pins/set-pull.md index 23f168aa..6d056455 100644 --- a/docs/reference/pins/set-pull.md +++ b/docs/reference/pins/set-pull.md @@ -16,8 +16,8 @@ pins.setPull(DigitalPin.P9, PinPullMode.PullDown); ### Parameters -* ``pin``: The micro:bit hardware pin to configure (``P0``-``P20``) -* ``to``: The pull to which to set the pin (**down**, **up**, or **none**) +* ``name``: The micro:bit hardware pin to configure (``P0``-``P20``) +* ``pull``: The pull to which to set the pin (**down**, **up**, or **none**) ### Example