doc: fix doc issues

https://onedigi.atlassian.net/browse/XBPL-425

Signed-off-by: Tatiana Leon <[email protected]>

Author: tatianaleon

digi/xbee/devices.py

@@ -9002,7 +9002,7 @@ def export(self, dir_path=None, name=None, desc=None):
 
         If the provided path already exists the file is removed.
 
-        Params:
+        Args:
             dir_path (String, optional, default=`None`): Absolute path of the
                 directory to export the network. It should not include the file
                 name. If not defined home directory is used.
@@ -9052,7 +9052,7 @@ def update_nodes(self, task_list):
         """
         Performs the provided update tasks. It blocks until all tasks finish.
 
-        Params:
+        Args:
             task_list (List or tuple): List of update tasks
                 (:class:`.FwUpdateTask` or :class:`.ProfileUpdateTask`)
 

digi/xbee/firmware.py

@@ -6440,7 +6440,7 @@ def _get_updater_candidates(self, net_discover=False):
         Returns a list of updater candidates extracted from the current
         network connections or from a neighbor discover.
 
-        Params:
+        Args:
             net_discover (Boolean, optional, default=False): `True` to perform
                 a neighbor discover, `False` to use current network connections.
 
@@ -6497,7 +6497,7 @@ def _is_valid_updater_candidate(self, node):
         Checks if the provided node is a valid candidate to be the updater node
         for the update process of the remote.
 
-        Params:
+        Args:
             node (:class: `.RemoteXBeeDevice`): The node to check if it is a
                 possible updater.
         """
@@ -6522,7 +6522,7 @@ def _determine_best_updater_from_candidates_list_zigbee(self, candidates):
         Determines which is the best updater node of the given list for a
         Zigbee network.
 
-        Params:
+        Args:
             candidates (List): List of possible XBee updater devices.
 
         Returns:
@@ -6546,7 +6546,7 @@ def _determine_best_updater_from_candidates_list_digimesh(self, candidates):
         Determines which is the best updater node of the given list for a
         DigiMesh network.
 
-        Params:
+        Args:
             candidates (List): List of possible XBee updater devices.
 
         Returns:
@@ -6701,7 +6701,7 @@ def _ota_callback(self, frame):
         """
         Callback used to receive OTA firmware update process status frames.
 
-        Params:
+        Args:
             frame (:class:`.XBeePacket`): Received XBee packet.
         """
         # If frame was already received, ignore this frame, just notify.
@@ -6737,7 +6737,7 @@ def _create_ota_explicit_packet(self, frame_id, payload):
         Creates and returns an OTA firmware update explicit packet using the
         given parameters.
 
-        Params:
+        Args:
             frame_id (Integer): Frame ID of the packet.
             payload (Bytearray): Packet payload.
 
@@ -6832,7 +6832,7 @@ def _send_firmware_data(self, data, ebl_file):
         """
         Sends the given firmware data to the updater device.
 
-        Params:
+        Args:
             Bytearray: Firmware data to send.
             ebl_file (:class:`._EBLFile`): Ebl file being transferred.
 

digi/xbee/models/message.py

@@ -320,7 +320,7 @@ class SMSMessage:
     This class is used within the library to read SMS sent to Cellular devices.
     """
 
-    __PHONE_NUMBER_PATTERN = "^\+?\d+$"
+    __PHONE_NUMBER_PATTERN = r"^\+?\d+$"
 
     def __init__(self, phone_number, data):
         """

digi/xbee/packets/cellular.py

@@ -22,7 +22,7 @@
 from digi.xbee.util import utils
 
 
-PATTERN_PHONE_NUMBER = "^\+?\d+$"
+PATTERN_PHONE_NUMBER = r"^\+?\d+$"
 """Pattern used to validate the phone number parameter of SMS packets."""
 
 

digi/xbee/packets/factory.py

@@ -44,8 +44,8 @@
     +----------------+  +-------------------+  +--------------------------- +  +----------------+
     |      0x7E      |  |   MSB   |   LSB   |  |   API-specific Structure   |  |     1 Byte     |
     +----------------+  +-------------------+  +----------------------------+  +----------------+
-                        \___________________________________  _________________________________/
-                                                            \/
+                        \\___________________________________  ________________________________/
+                                                            \\/
                                                 Characters Escaped If Needed
 
                    MSB = Most Significant Byte, LSB = Least Significant Byte
@@ -121,7 +121,7 @@
     SocketReceiveFromPacket, SocketStatePacket
 from digi.xbee.packets.wifi import RemoteATCommandWifiPacket, \
     RemoteATCommandResponseWifiPacket, IODataSampleRxIndicatorWifiPacket
-from digi.xbee.packets.zigbee import RegisterJoiningDevicePacket,\
+from digi.xbee.packets.zigbee import RegisterJoiningDevicePacket, \
     RegisterDeviceStatusPacket, RouteRecordIndicatorPacket, OTAFirmwareUpdateStatusPacket
 from digi.xbee.packets.bluetooth import BluetoothGAPScanLegacyAdvertisementResponsePacket, \
     BluetoothGAPScanExtendedAdvertisementResponsePacket, BluetoothGAPScanStatusPacket

digi/xbee/profile.py

@@ -1387,7 +1387,7 @@ def xbee(self):
     @property
     def profile_path(self):
         """
-        Gets the *.xpro file path.
+        Gets the `*.xpro` file path.
 
         Returns:
             String: The profile path for the update task.

digi/xbee/reader.py

@@ -42,7 +42,6 @@
 from digi.xbee.exception import TimeoutException, InvalidPacketException
 from digi.xbee.io import IOSample
 
-
 # Maximum number of parallel callbacks.
 MAX_PARALLEL_CALLBACKS = 50
 
@@ -65,6 +64,7 @@ def callback_prototype(*args, **kwargs):
     .. seealso::
        | list (Python standard class)
     """
+
     def __call__(self, *args, **kwargs):
         for func in self:
             future = EXECUTOR.submit(func, *args, **kwargs)
@@ -510,7 +510,7 @@ class methods. This callbacks must have a certain header, see each event
     Here are the parameters which will be received by the event callbacks,
     depending on which event it is in each case:
 
-    The following parameters are passed via \*\*kwargs to event callbacks of:
+    The following parameters are passed via \\*\\*kwargs to event callbacks of:
 
     1. PacketReceived:
         1.1 received_packet (:class:`.XBeeAPIPacket`): Received packet.
@@ -1659,11 +1659,11 @@ def __execute_user_callbacks(self, packet, remote=None):
         # Bluetooth BLE GAP Scan Legacy Advertisement Response
         elif f_type == ApiFrameType.BLUETOOTH_GAP_SCAN_LEGACY_ADVERTISEMENT_RESPONSE:
             self.__ble_gap_scan_received(BLEGAPScanLegacyAdvertisementMessage(
-                                         packet.address,
-                                         packet.address_type,
-                                         packet.advertisement_flags,
-                                         packet.rssi,
-                                         packet.payload))
+                packet.address,
+                packet.address_type,
+                packet.advertisement_flags,
+                packet.rssi,
+                packet.payload))
             self._log.debug(self._LOG_PATTERN.format(
                 comm_iface=str(self.__xbee.comm_iface), event="RECEIVED",
                 fr_type="BLE GAP SCAN LEGACY", sender=str(packet.address),
@@ -1672,17 +1672,17 @@ def __execute_user_callbacks(self, packet, remote=None):
         # Bluetooth BLE GAP Scan Extended Advertisement Response
         elif f_type == ApiFrameType.BLUETOOTH_GAP_SCAN_EXTENDED_ADVERTISEMENT_RESPONSE:
             self.__ble_gap_scan_received(BLEGAPScanExtendedAdvertisementMessage(
-                                         packet.address,
-                                         packet.address_type,
-                                         packet.advertisement_flags,
-                                         packet.rssi,
-                                         packet.advertisement_set_id,
-                                         packet.primary_phy,
-                                         packet.secondary_phy,
-                                         packet.tx_power,
-                                         packet.periodic_interval,
-                                         packet.data_completeness,
-                                         packet.payload))
+                packet.address,
+                packet.address_type,
+                packet.advertisement_flags,
+                packet.rssi,
+                packet.advertisement_set_id,
+                packet.primary_phy,
+                packet.secondary_phy,
+                packet.tx_power,
+                packet.periodic_interval,
+                packet.data_completeness,
+                packet.payload))
             self._log.debug(self._LOG_PATTERN.format(
                 comm_iface=str(self.__xbee.comm_iface), event="RECEIVED",
                 fr_type="BLE GAP SCAN EXTENDED", sender=str(packet.address),
@@ -1691,7 +1691,7 @@ def __execute_user_callbacks(self, packet, remote=None):
         # Bluetooth BLE GAP Scan Status Response
         elif f_type == ApiFrameType.BLUETOOTH_GAP_SCAN_STATUS:
             self.__ble_gap_scan_status_received(BLEGAPScanStatusMessage(
-                                                packet.scan_status))
+                packet.scan_status))
             self._log.debug(self._LOG_PATTERN.format(
                 comm_iface=str(self.__xbee.comm_iface), event="RECEIVED",
                 fr_type="BLE GAP SCAN STATUS", sender="None",

digi/xbee/util/exportutils.py

@@ -30,7 +30,7 @@ def generate_network_xml(xbee, date_now=None, name=None, desc=None):
     """
     Generates the XML hierarchy representing the network of the given XBee.
 
-    Params:
+    Args:
         xbee (:class:`.XBeeDevice`): Local XBee node.
         date_now (:class: `datetime.datetime`, optional, default=`None`): Date
             to set in the XML.
@@ -69,7 +69,7 @@ def _generate_nodes_xml(xbee, level=0):
     """
     Generates the XML element representing the network of the given XBee.
 
-    Params:
+    Args:
         xbee (:class:`.XBeeDevice`): Local XBee node.
         level (Integer, optional, default=0): Indentation level.
 
@@ -96,7 +96,7 @@ def _generate_node_xml(node, level=0):
     """
     Generates the XML element representing the given XBee node.
 
-    Params:
+    Args:
         xbee (:class:`.AbstractXBeeDevice`): XBee node.
         level (Integer, optional, default=0): Indentation level.
 
@@ -146,7 +146,7 @@ def _generate_serial_config_xml(serial_port, level=0):
     """
     Generates the XML element representing the given serial port.
 
-    Params:
+    Args:
         serial_port (:class:`serial.serialutil.SerialBase`): Serial port.
         level (Integer, optional, default=0): Indentation level.
 
@@ -189,7 +189,7 @@ def _generate_connections_xml(node, connections, level=0):
     """
     Generates the XML node representing the given connections.
 
-    Params:
+    Args:
         xbee (:class:`.AbstractXBeeDevice`): XBee node.
         connections (List): List of :class:`.Connection`.
         level (Integer, optional, default=0): Indentation level.

digi/xbee/util/srp.py

@@ -20,6 +20,7 @@
 
 from digi.xbee.util import utils
 
+
 @unique
 class HAType(Enum):
     """
@@ -78,6 +79,7 @@ def get(cls, code):
 
 HAType.__doc__ += utils.doc_enum(HAType)
 
+
 @unique
 class NgGroupParams(Enum):
     """
@@ -286,11 +288,11 @@ def get(cls, code):
 
 
 def create_salted_verification_key(user, password, hash_alg=HAType.SHA256,
-                 ng_type=NgGroupParams.NG_1024, salt_len=4):
+                                   ng_type=NgGroupParams.NG_1024, salt_len=4):
     """
     Generates a salted verification key for the provided username and password.
 
-    Params:
+    Args:
         user (String): Username string.
         password (String): Plain text password.
         hash_alg (:class:`.HAType`, optional, default=`HAType.SHA256`): Hash algorithm.
@@ -301,39 +303,39 @@ def create_salted_verification_key(user, password, hash_alg=HAType.SHA256,
     Returns:
         Tuple (bytes, bytes): Tuple with salt and verifier.
     """
-    s = generate_salt(l=salt_len)
+    s = generate_salt(length=salt_len)
     v = generate_verifier(user, password, hash_alg=hash_alg, ng_type=ng_type,
                           salt=s, sep=":")
 
     return s, v
 
 
-def generate_salt(l=4):
+def generate_salt(length=4):
     """
     Generates new salt.
 
-    Params:
-        l (Integer, optional, default=`4`): Number of bytes.
+    Args:
+        length (Integer, optional, default=`4`): Number of bytes.
 
     Returns:
         Bytes: The generated salt.
     """
-    return os.urandom(l)
+    return os.urandom(length)
 
 
 def generate_verifier(user, password, salt, hash_alg=HAType.SHA256,
                       ng_type=NgGroupParams.NG_1024, sep=":"):
     """
     Calculates a verifier for the provided salt and configured password.
 
-    Params:
+    Args:
         user (String): Username string.
         password (String): Plain text password.
         salt (bytes): Salt to generate a verifier.
         hash_alg (:class:`.HAType`, optional, default=`HAType.SHA256`): Hash algorithm.
         ng_type (:class:`.NgGroupParams`, optional, default=`NgGroupParams.NG_1024`):
             Prime generator type.
-        sep (String, optional, default= `:`): Separator string.
+        sep (String, optional): Separator string.
 
     Returns:
         Bytes: The generated verifier.
@@ -352,12 +354,12 @@ def __calculate_x(user, password, salt, hash_alg=HAType.SHA256, sep=":"):
     """
     Calculates the user secret parameter.
 
-    Params:
+    Args:
         user (String): Username string.
         password (String): Plain text password.
         salt (bytes): Salt byte array.
         hash_alg (:class:`.HAType`, optional, default=`HAType.SHA256`): Hash algorithm.
-        sep (String, optional, default= `:`): Separator string.
+        sep (String, optional): Separator string.
 
     Returns:
         Integer: The user secret value.
@@ -376,7 +378,7 @@ def __hash(hash_alg, *args):
     """
     Calculates the hash of the provided arguments.
 
-    Params:
+    Args:
         args: Variable argument list of object to use for hash.
 
     Returns:
@@ -393,7 +395,7 @@ def __to_bytes(obj):
     """
     Converts object to byte array, with optional context.
 
-    Params:
+    Args:
         obj: Object to convert.
 
     Returns:

doc/api/digi.xbee.models.rst

@@ -21,5 +21,6 @@ Submodules
    digi.xbee.models.message
    digi.xbee.models.options
    digi.xbee.models.protocol
+   digi.xbee.models.statistics
    digi.xbee.models.status
    digi.xbee.models.zdo