diff --git a/libs/microbit/_locales/microbit-jsdoc-strings.json b/libs/microbit/_locales/microbit-jsdoc-strings.json index 81ff1d58..98e24602 100644 --- a/libs/microbit/_locales/microbit-jsdoc-strings.json +++ b/libs/microbit/_locales/microbit-jsdoc-strings.json @@ -41,14 +41,14 @@ "input.acceleration|param|dimension": "TODO", "input.buttonIsPressed": "Get the button state (pressed or not) for ``A`` and ``B``.", "input.calibrate": "Obsolete, compass calibration is automatic.", - "input.compassHeading": "Get the current compass compass heading in degrees.", + "input.compassHeading": "Get the current compass heading in degrees.", "input.lightLevel": "Reads the light level applied to the LED screen in a range from ``0`` (dark) to ``255`` bright.", "input.magneticForce": "Get the magnetic force value in ``micro-Teslas`` (``µT``). This function is not supported in the simulator.", "input.magneticForce|param|dimension": "TODO", "input.onButtonPressed": "Do something when a button (``A``, ``B`` or both ``A+B``) is pressed", "input.onButtonPressed|param|body": "TODO", "input.onButtonPressed|param|button": "TODO", - "input.onGesture": "Attaches code to run when the screen is facing up.", + "input.onGesture": "Do something when when a gesture is done (like shaking the micro:bit).", "input.onGesture|param|body": "TODO", "input.onLogoDown": "Attaches code to run when the logo is oriented downwards and the board is vertical.", "input.onLogoDown|param|body": "TODO", @@ -68,7 +68,7 @@ "input.onShake|param|body": "TODO", "input.pinIsPressed": "Get the pin state (pressed or not). Requires to hold the ground to close the circuit.", "input.pinIsPressed|param|name": "pin used to detect the touch", - "input.rotation": "The pitch of the device, rotation along the ``x-axis``, in degrees.", + "input.rotation": "The pitch or roll of the device, rotation along the ``x-axis`` or ``y-axis``, in degrees.", "input.rotation|param|kind": "TODO", "input.runningTime": "Gets the number of milliseconds elapsed since power on.", "input.setAccelerometerRange": "Sets the accelerometer sample range in gravities.", diff --git a/libs/microbit/input.cpp b/libs/microbit/input.cpp index 3a9cc8c2..9708257f 100644 --- a/libs/microbit/input.cpp +++ b/libs/microbit/input.cpp @@ -122,7 +122,7 @@ namespace input { } /** - * Attaches code to run when the screen is facing up. + * Do something when when a gesture is done (like shaking the micro:bit). * @param body TODO */ //% help=input/on-gesture weight=84 blockGap=8 @@ -199,7 +199,7 @@ namespace input { } /** - * Get the current compass compass heading in degrees. + * Get the current compass heading in degrees. */ //% help=input/compass-heading //% weight=56 icon="\uf14e" @@ -257,7 +257,7 @@ namespace input { } /** - * The pitch of the device, rotation along the ``x-axis``, in degrees. + * The pitch or roll of the device, rotation along the ``x-axis`` or ``y-axis``, in degrees. * @param kind TODO */ //% help=input/rotation weight=52 diff --git a/libs/microbit/shims.d.ts b/libs/microbit/shims.d.ts index 68751482..42dc3fa1 100644 --- a/libs/microbit/shims.d.ts +++ b/libs/microbit/shims.d.ts @@ -224,7 +224,7 @@ declare namespace input { function onButtonPressed(button: Button, body: () => void): void; /** - * Attaches code to run when the screen is facing up. + * Do something when when a gesture is done (like shaking the micro:bit). * @param body TODO */ //% help=input/on-gesture weight=84 blockGap=8 @@ -270,7 +270,7 @@ declare namespace input { function pinIsPressed(name: TouchPin): boolean; /** - * Get the current compass compass heading in degrees. + * Get the current compass heading in degrees. */ //% help=input/compass-heading //% weight=56 icon="\uf14e" @@ -305,7 +305,7 @@ declare namespace input { function lightLevel(): number; /** - * The pitch of the device, rotation along the ``x-axis``, in degrees. + * The pitch or roll of the device, rotation along the ``x-axis`` or ``y-axis``, in degrees. * @param kind TODO */ //% help=input/rotation weight=52