KevinMidboe/python-gpiozero
1
0
Fork 0
mirror of https://github.com/KevinMidboe/python-gpiozero.git synced 2025-10-29 17:50:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix prototypes in docs

Browse Source 
The prototypes in the docs are rigged to make out the first parameter as
mandatory (as it effectively is); however this does mean you've got to
remember to update the prototype when you modify it in the code! :)
This commit is contained in:
Dave Jones
2016-01-31 19:59:33 +00:00
parent d77ee6e71f
commit e52ad37200
3 changed files with 45 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api_output.rst
View File

@@ -16,25 +16,25 @@ everyday components. Components must be wired up correctly before use in code.
LED
===
.. autoclass:: LED(pin, active_high=True)
.. autoclass:: LED(pin, active_high=True, initial_value=False)
:members: on, off, toggle, blink, pin, is_lit
PWMLED
======
.. autoclass:: PWMLED(pin, frequency=100)
.. autoclass:: PWMLED(pin, active_high=True, initial_value=0, frequency=100)
:members: on, off, toggle, blink, pin, is_lit, value
Buzzer
======
.. autoclass:: Buzzer(pin, active_high=True)
.. autoclass:: Buzzer(pin, active_high=True, initial_value=False)
:members: on, off, toggle, beep, pin, is_active
RGBLED
======
.. autoclass:: RGBLED(red, green, blue)
.. autoclass:: RGBLED(red, green, blue, active_high=True)
:members: on, off, red, green, blue, value
Motor