summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2014-06-04 13:46:35 +0100
committerDamien George <damien.p.george@gmail.com>2014-06-04 13:46:35 +0100
commit30583f58d5363657d74829160097c58aed4f3ce1 (patch)
treef533c97e06860f8724ab0a62ae0cdc042cbc3b56
parent95fd3528c12c0ae548fadc5e139e5e1dcf1da63e (diff)
parent3d5ffa83180b216fc44fb151771141c12a9c425b (diff)
Merge pull request #653 from Metallicow/switch-example-correction
remove `__doc__ =` and fix tweak doc diffs
-rw-r--r--examples/switch.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/examples/switch.py b/examples/switch.py
index 23c4b5e2b..0efaf2267 100644
--- a/examples/switch.py
+++ b/examples/switch.py
@@ -1,4 +1,4 @@
-__doc__ = """
+"""
switch.py
=========
@@ -9,7 +9,7 @@ Example Usage::
Micro Python v1.0.1 on 2014-05-12; PYBv1.0 with STM32F405RG
Type "help()" for more information.
>>> import switch
- >>> switch.run_loop([2, 3])
+ >>> switch.run_loop()
Loop started.
Press Ctrl+C to break out of the loop.
@@ -28,8 +28,8 @@ def run_loop(leds=all_leds):
"""
Start the loop.
- :param `use_leds`: Which LEDs to light up upon switch press.
- :type `use_leds`: sequence of LED objects
+ :param `leds`: Which LEDs to light up upon switch press.
+ :type `leds`: sequence of LED objects
"""
print('Loop started.\nPress Ctrl+C to break out of the loop.')
while 1: