c_meyer/pxt-calliope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Second pass. Clarify API's functionality.

Browse Source
This commit is contained in:
Ron Hale-Evans
2016-06-14 12:12:26 -07:00
parent 6e62acb384
commit 62b6b8e9eb
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/led/brightness.md
View File

@@ -1,6 +1,6 @@
# Brightness
Find how bright the [LED screen](/device/screen) is.
Find how bright the [LED screen](/device/screen) is _when it is turned on_.
```sig
led.brightness();
@@ -8,11 +8,11 @@ led.brightness();
### Returns
* a [Number](/reference/types/number) that means how bright the screen is, from `0` (darkest) to `255` (brightest). For example, the number `127` means the screen is halfway bright.
* a [number](/reference/types/number) that means how bright the screen is when it is turned on, from `0` (darkest) to `255` (brightest). For example, the number `127` means the screen is halfway bright when it is turned on.
### Example: highest brightness
This program makes the screen completely bright if it is not that way already:
This program makes the screen completely bright when it is turned on (if it is not that way already):
```blocks
if (led.brightness() < 255) {