summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2014-12-16 11:55:46 +0000
committerDamien George <damien.p.george@gmail.com>2014-12-16 11:55:46 +0000
commit9642846d71451ce12579da421567ebf63560c829 (patch)
tree360c87f5b9e3a2e9cd48b06613e5aaa79b99d510 /docs
parent00785613030f83516dfe3073a17c58c4657cfe89 (diff)
docs: Define more clearly the behaviour of LED methods.
Addresses issue #1006.
Diffstat (limited to 'docs')
-rw-r--r--docs/library/pyb.LED.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/library/pyb.LED.rst b/docs/library/pyb.LED.rst
index 02fc13246..461ea57d3 100644
--- a/docs/library/pyb.LED.rst
+++ b/docs/library/pyb.LED.rst
@@ -31,8 +31,9 @@ Methods
.. method:: led.on()
- Turn the LED on.
+ Turn the LED on, to maximum intensity.
.. method:: led.toggle()
- Toggle the LED between on and off.
+ Toggle the LED between on (maximum intensity) and off. If the LED is at
+ non-zero intensity then it is considered "on" and toggle will turn it off.