Skip to content

Commit

Permalink
doc: add missing enumeration values in documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Tatiana Leon <[email protected]>
  • Loading branch information
tatianaleon committed Nov 12, 2019
1 parent 50baa17 commit aae4a29
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 1 deletion.
6 changes: 5 additions & 1 deletion digi/xbee/devices.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,6 @@ def __init__(self, local_xbee_device=None, serial_port=None, sync_ops_timeout=_D

self._packet_listener = None


self.__generic_lock = threading.Lock()

def __eq__(self, other):
Expand Down Expand Up @@ -7346,6 +7345,9 @@ def get(cls, code):
return None


NetworkEventType.__doc__ += utils.doc_enum(NetworkEventType)


@unique
class NetworkEventReason(Enum):
"""
Expand Down Expand Up @@ -7397,3 +7399,5 @@ def get(cls, code):
return reason

return None

NetworkEventReason.__doc__ += utils.doc_enum(NetworkEventReason)
1 change: 1 addition & 0 deletions digi/xbee/io.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ def get(cls, code):


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


class IOSample(object):
Expand Down
3 changes: 3 additions & 0 deletions digi/xbee/models/protocol.py
Original file line number Diff line number Diff line change
Expand Up @@ -403,3 +403,6 @@ def get(cls, identifier):
return item

return None


Role.__doc__ += utils.doc_enum(Role)
18 changes: 18 additions & 0 deletions digi/xbee/profile.py
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,9 @@ def baudrate(self):
return self.__baudrate


FirmwareBaudrate.__doc__ += utils.doc_enum(FirmwareBaudrate)


@unique
class FirmwareParity(Enum):
"""
Expand Down Expand Up @@ -245,6 +248,9 @@ def parity(self):
return self.__parity


FirmwareParity.__doc__ += utils.doc_enum(FirmwareParity)


@unique
class FirmwareStopbits(Enum):
"""
Expand Down Expand Up @@ -303,6 +309,9 @@ def stop_bits(self):
return self.__stop_bits


FirmwareStopbits.__doc__ += utils.doc_enum(FirmwareStopbits)


@unique
class FlashFirmwareOption(Enum):
"""
Expand Down Expand Up @@ -359,6 +368,9 @@ def description(self):
return self.__description


FlashFirmwareOption.__doc__ += utils.doc_enum(FlashFirmwareOption)


@unique
class XBeeSettingType(Enum):
"""
Expand Down Expand Up @@ -417,6 +429,9 @@ def description(self):
return self.__description


XBeeSettingType.__doc__ += utils.doc_enum(XBeeSettingType)


@unique
class XBeeSettingFormat(Enum):
"""
Expand Down Expand Up @@ -476,6 +491,9 @@ def description(self):
return self.__description


XBeeSettingFormat.__doc__ += utils.doc_enum(XBeeSettingFormat)


class XBeeProfileSetting(object):
"""
This class represents an XBee profile setting and provides information like
Expand Down

0 comments on commit aae4a29

Please sign in to comment.