@@ -115,8 +115,7 @@ def wrap_socket(self, socket, server_hostname=None):
115115
116116
117117class MQTT :
118- """MQTT Client for CircuitPython
119-
118+ """MQTT Client for CircuitPython.
120119 :param str broker: MQTT Broker URL or IP Address.
121120 :param int port: Optional port definition, defaults to 8883.
122121 :param str username: Username for broker authentication.
@@ -448,7 +447,6 @@ def username_pw_set(self, username, password=None):
448447 # pylint: disable=too-many-branches, too-many-statements, too-many-locals
449448 def connect (self , clean_session = True , host = None , port = None , keep_alive = None ):
450449 """Initiates connection with the MQTT Broker.
451-
452450 :param bool clean_session: Establishes a persistent session.
453451 :param str host: Hostname or IP address of the remote broker.
454452 :param int port: Network port of the remote broker.
@@ -727,23 +725,10 @@ def subscribe(self, topic, qos=0):
727725
728726 def unsubscribe (self , topic ):
729727 """Unsubscribes from a MQTT topic.
730-
731728 :param str,list topic: Unique MQTT topic identifier string or a list
732729 of tuples, where each tuple contains an MQTT topic identier
733730 string.
734731
735- Example of unsubscribing from a topic string.
736-
737- .. code-block:: python
738-
739- mqtt_client.unsubscribe('topics/ledState')
740-
741- Example of unsubscribing from multiple topics.
742-
743- .. code-block:: python
744-
745- mqtt_client.unsubscribe([('topics/ledState'), ('topics/servoAngle')])
746-
747732 """
748733 topics = None
749734 if isinstance (topic , str ):
@@ -790,8 +775,8 @@ def unsubscribe(self, topic):
790775
791776 def reconnect (self , resub_topics = True ):
792777 """Attempts to reconnect to the MQTT broker.
793-
794778 :param bool resub_topics: Resubscribe to previously subscribed topics.
779+
795780 """
796781 if self .logger :
797782 self .logger .debug ("Attempting to reconnect with MQTT broker" )
@@ -996,7 +981,6 @@ def is_connected(self):
996981 # Logging
997982 def enable_logger (self , logger , log_level = 20 ):
998983 """Enables library logging provided a `logger` object.
999-
1000984 :param logging.Logger logger: A python logger pacakge.
1001985 :param log_level: Numeric value of a logging level, defaults to `logging.INFO`.
1002986
0 commit comments