Merge pull request #653 from Metallicow/switch-example-correction

remove `__doc__ =` and fix tweak doc diffs
This commit is contained in:
Damien George 2014-06-04 13:46:35 +01:00
commit 30583f58d5

View File

@ -1,4 +1,4 @@
__doc__ = """ """
switch.py switch.py
========= =========
@ -9,7 +9,7 @@ Example Usage::
Micro Python v1.0.1 on 2014-05-12; PYBv1.0 with STM32F405RG Micro Python v1.0.1 on 2014-05-12; PYBv1.0 with STM32F405RG
Type "help()" for more information. Type "help()" for more information.
>>> import switch >>> import switch
>>> switch.run_loop([2, 3]) >>> switch.run_loop()
Loop started. Loop started.
Press Ctrl+C to break out of the loop. Press Ctrl+C to break out of the loop.
@ -28,8 +28,8 @@ def run_loop(leds=all_leds):
""" """
Start the loop. Start the loop.
:param `use_leds`: Which LEDs to light up upon switch press. :param `leds`: Which LEDs to light up upon switch press.
:type `use_leds`: sequence of LED objects :type `leds`: sequence of LED objects
""" """
print('Loop started.\nPress Ctrl+C to break out of the loop.') print('Loop started.\nPress Ctrl+C to break out of the loop.')
while 1: while 1: