Some minor doc fixes for 1.2

This commit is contained in:
Dave Jones
2016-04-09 10:30:03 +01:00
parent 4e75d49355
commit 8c4096b19c
3 changed files with 12 additions and 8 deletions

View File

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

View File

@@ -31,6 +31,13 @@ class CompositeOutputDevice(SourceMixin, CompositeDevice):
Extends :class:`CompositeDevice` with :meth:`on`, :meth:`off`, and Extends :class:`CompositeDevice` with :meth:`on`, :meth:`off`, and
:meth:`toggle` methods for controlling subordinate output devices. Also :meth:`toggle` methods for controlling subordinate output devices. Also
extends :attr:`value` to be writeable. 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): def on(self):

View File

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