KevinMidboe/python-gpiozero
1
0
Fork 0
mirror of https://github.com/KevinMidboe/python-gpiozero.git synced 2026-02-01 06:05:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add pin_factory to all relevant class docs

Browse Source 
Also tell a whole load of lies about what's a keyword-only arg. In the
vast majority of cases, pin_factory (and other args) *aren't*
keyword-only ... but we'd really like them to be, it's just difficult
while maintaining py2 compatibility.
This commit is contained in:
Dave Jones
2017-07-13 21:01:42 +01:00
parent 8958874a77
commit 9fdc093837
6 changed files with 33 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/api_boards.rst
View File

@@ -18,21 +18,21 @@ individually.
LEDBoard
========
.. autoclass:: LEDBoard(\*pins, pwm=False, active_high=True, initial_value=False, \*\*named_pins)
.. autoclass:: LEDBoard(\*pins, pwm=False, active_high=True, initial_value=False, pin_factory=None, \*\*named_pins)
:inherited-members:
:members:
LEDBarGraph
===========
.. autoclass:: LEDBarGraph(\*pins, pwm=False, active_high=True, initial_value=0)
.. autoclass:: LEDBarGraph(\*pins, pwm=False, active_high=True, initial_value=0, pin_factory=None)
:inherited-members:
:members:
ButtonBoard
===========
.. autoclass:: ButtonBoard(\*pins, pull_up=True, bounce_time=None, hold_time=1, hold_repeat=False, \*\*named_pins)
.. autoclass:: ButtonBoard(\*pins, pull_up=True, bounce_time=None, hold_time=1, hold_repeat=False, pin_factory=None, \*\*named_pins)
:inherited-members:
:members:
@@ -130,14 +130,14 @@ Energenie
StatusZero
==========
.. autoclass:: StatusZero
.. autoclass:: StatusZero(\*labels, pwm=False, active_high=True, initial_value=False, pin_factory=None)
:inherited-members:
:members:
StatusBoard
===========
.. autoclass:: StatusBoard
.. autoclass:: StatusBoard(\*labels, pwm=False, active_high=True, initial_value=False, pin_factory=None)
:inherited-members:
:members:
@@ -168,17 +168,17 @@ to construct classes for their own devices.
LEDCollection
=============
.. autoclass:: LEDCollection
.. autoclass:: LEDCollection(\*pins, pwm=False, active_high=True, initial_value=False, pin_factory=None, \*\*named_pins)
:members:
CompositeOutputDevice
=====================
.. autoclass:: CompositeOutputDevice(\*args, _order=None, \*\*kwargs)
.. autoclass:: CompositeOutputDevice(\*args, _order=None, pin_factory=None, \*\*kwargs)
:members:
CompositeDevice
===============
.. autoclass:: CompositeDevice(\*args, _order=None, \*\*kwargs)
.. autoclass:: CompositeDevice(\*args, _order=None, pin_factory=None, \*\*kwargs)
:members: