Skip to content

Commit 2fbb3c6

Browse files
committed
Exclude docs from flake8. Update ZigBee docstring.
1 parent 0e58ec4 commit 2fbb3c6

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/index.rst

-7
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,9 @@ Contents:
1111
.. toctree::
1212
:maxdepth: 2
1313

14-
.. automodule:: xbee_helper
15-
16-
.. autoclass:: ZigBee
17-
:members:
18-
19-
2014
Indices and tables
2115
==================
2216

2317
* :ref:`genindex`
2418
* :ref:`modindex`
2519
* :ref:`search`
26-

setup.cfg

+2
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ message = Bump version to {new_version}
1111
[aliases]
1212
test = pytest
1313

14+
[flake8]
15+
exclude = docs

xbee_helper/device.py

+5
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,11 @@ def convert_adc(value, output_type, max_volts):
8585
class ZigBee(object):
8686
"""
8787
Adds convenience methods for a ZigBee.
88+
89+
Most of the methods take a `dest_addr_long` parameter. If provided, this
90+
is used to send a remote AT command to a device on the ZigBee network. If
91+
the parameter is not provided, then an AT command will be sent to the
92+
local device on the serial port.
8893
"""
8994
_rx_frames = {}
9095
_frame_id = 1

0 commit comments

Comments
 (0)