Skip to content

Commit aae4a29

Browse files
committed
doc: add missing enumeration values in documentation
Signed-off-by: Tatiana Leon <[email protected]>
1 parent 50baa17 commit aae4a29

File tree

4 files changed

+27
-1
lines changed

4 files changed

+27
-1
lines changed

digi/xbee/devices.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,6 @@ def __init__(self, local_xbee_device=None, serial_port=None, sync_ops_timeout=_D
127127

128128
self._packet_listener = None
129129

130-
131130
self.__generic_lock = threading.Lock()
132131

133132
def __eq__(self, other):
@@ -7346,6 +7345,9 @@ def get(cls, code):
73467345
return None
73477346

73487347

7348+
NetworkEventType.__doc__ += utils.doc_enum(NetworkEventType)
7349+
7350+
73497351
@unique
73507352
class NetworkEventReason(Enum):
73517353
"""
@@ -7397,3 +7399,5 @@ def get(cls, code):
73977399
return reason
73987400

73997401
return None
7402+
7403+
NetworkEventReason.__doc__ += utils.doc_enum(NetworkEventReason)

digi/xbee/io.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ def get(cls, code):
175175

176176

177177
IOValue.lookupTable = {x.code: x for x in IOValue}
178+
IOValue.__doc__ += utils.doc_enum(IOValue)
178179

179180

180181
class IOSample(object):

digi/xbee/models/protocol.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -403,3 +403,6 @@ def get(cls, identifier):
403403
return item
404404

405405
return None
406+
407+
408+
Role.__doc__ += utils.doc_enum(Role)

digi/xbee/profile.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,9 @@ def baudrate(self):
185185
return self.__baudrate
186186

187187

188+
FirmwareBaudrate.__doc__ += utils.doc_enum(FirmwareBaudrate)
189+
190+
188191
@unique
189192
class FirmwareParity(Enum):
190193
"""
@@ -245,6 +248,9 @@ def parity(self):
245248
return self.__parity
246249

247250

251+
FirmwareParity.__doc__ += utils.doc_enum(FirmwareParity)
252+
253+
248254
@unique
249255
class FirmwareStopbits(Enum):
250256
"""
@@ -303,6 +309,9 @@ def stop_bits(self):
303309
return self.__stop_bits
304310

305311

312+
FirmwareStopbits.__doc__ += utils.doc_enum(FirmwareStopbits)
313+
314+
306315
@unique
307316
class FlashFirmwareOption(Enum):
308317
"""
@@ -359,6 +368,9 @@ def description(self):
359368
return self.__description
360369

361370

371+
FlashFirmwareOption.__doc__ += utils.doc_enum(FlashFirmwareOption)
372+
373+
362374
@unique
363375
class XBeeSettingType(Enum):
364376
"""
@@ -417,6 +429,9 @@ def description(self):
417429
return self.__description
418430

419431

432+
XBeeSettingType.__doc__ += utils.doc_enum(XBeeSettingType)
433+
434+
420435
@unique
421436
class XBeeSettingFormat(Enum):
422437
"""
@@ -476,6 +491,9 @@ def description(self):
476491
return self.__description
477492

478493

494+
XBeeSettingFormat.__doc__ += utils.doc_enum(XBeeSettingFormat)
495+
496+
479497
class XBeeProfileSetting(object):
480498
"""
481499
This class represents an XBee profile setting and provides information like

0 commit comments

Comments
 (0)