From 4a8d9ee9cd4191ffd6f1265eb34cef4ed4707167 Mon Sep 17 00:00:00 2001 From: Jan Karger Date: Thu, 8 Mar 2018 21:57:28 +0100 Subject: [PATCH] Update scroll-image.md (#701) Just change the documentation here, cause the underlying API doesn't work correctly yet https://github.com/lancaster-university/microbit-dal/blob/2cff906f019944ae15d532157c1301c940f67862/source/drivers/MicroBitDisplay.cpp#L931 So negative values are not working for now. --- docs/reference/images/scroll-image.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/reference/images/scroll-image.md b/docs/reference/images/scroll-image.md index 980e38e6..7821ec2e 100644 --- a/docs/reference/images/scroll-image.md +++ b/docs/reference/images/scroll-image.md @@ -11,14 +11,11 @@ item.scrollImage(5, 200); ## Parameters * a [number](/types/number) that means - how many LEDs to scroll at a time, from right to left or - left to right. If you use a positive number like `2`, the image - will scroll from the right side of the screen to the left. - If you use a negative number like `-2`, the image will scroll - in the other direction. If you use `5` or `-5`, the image - will scroll one **frame** at a time. (A frame is a part of the - image. It is a square with five LEDs on a side). This is - useful for **animation**. + how many LEDs to scroll at a time from right to left. + You must use a positive number like `2`. + If you use `5`, the image will scroll one **frame** at a time. + (A frame is a part of the image. It is a square with five LEDs + on a side). This is useful for **animation**. * a [number](/types/number) that means how many milliseconds to wait before scrolling the amount that