Merge pull request #271 from waveform80/doc-fixes-for-12

Some minor doc fixes for 1.2
This commit is contained in:
Dave Jones
2016-04-09 10:36:31 +01:00
3 changed files with 12 additions and 8 deletions

View File

@@ -87,6 +87,9 @@ Base Classes
.. autoclass:: CompositeDevice(\*args, _order=None, \*\*kwargs)
:members:
.. autoclass:: CompositeOutputDevice(\*args, _order=None, \*\*kwargs)
:members:
Input Devices
=============
@@ -114,18 +117,12 @@ Output Devices
SPI Devices
===========
.. autoclass:: SPIDevice
:members:
.. autoclass:: AnalogInputDevice
:members:
Composite Devices
=================
.. autoclass:: CompositeOutputDevice
:members:
.. autoclass:: LEDCollection
:members:

View File

@@ -31,6 +31,13 @@ class CompositeOutputDevice(SourceMixin, CompositeDevice):
Extends :class:`CompositeDevice` with :meth:`on`, :meth:`off`, and
:meth:`toggle` methods for controlling subordinate output devices. Also
extends :attr:`value` to be writeable.
:param list _order:
If specified, this is the order of named items specified by keyword
arguments (to ensure that the :attr:`value` tuple is constructed with a
specific order). All keyword arguments *must* be included in the
collection. If omitted, an alphabetically sorted order will be selected
for keyword arguments.
"""
def on(self):

View File

@@ -257,8 +257,8 @@ class CompositeDevice(Device):
If specified, this is the order of named items specified by keyword
arguments (to ensure that the :attr:`value` tuple is constructed with a
specific order). All keyword arguments *must* be included in the
collection. If omitted, an arbitrary order will be selected for keyword
arguments.
collection. If omitted, an alphabetically sorted order will be selected
for keyword arguments.
"""
def __init__(self, *args, **kwargs):
self._all = ()