Skip to content

Commit 341859b

Browse files
author
brentru
committed
fix inher. autodoc issues
1 parent d0f32a3 commit 341859b

File tree

2 files changed

+5
-15
lines changed

2 files changed

+5
-15
lines changed

adafruit_minimqtt/adafruit_minimqtt.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ class MMQTTException(Exception):
7474

7575
# Legacy ESP32SPI Socket API
7676
def set_socket(sock, iface=None):
77-
"""Legacy API for setting the socket and network interface, use a `Session` instead.
77+
"""Legacy API for setting the socket and network interface, use a Session instead.
7878
7979
:param sock: socket object.
8080
:param iface: internet interface object
@@ -974,9 +974,9 @@ def is_connected(self):
974974

975975
# Logging
976976
def enable_logger(self, logger, log_level=20):
977-
"""Enables library logging provided a `logger` object.
978-
:param logging.Logger logger: A python logger pacakge.
979-
:param log_level: Numeric value of a logging level, defaults to `logging.INFO`.
977+
"""Enables library logging provided a logger object.
978+
:param logger: A python logger pacakge.
979+
:param log_level: Numeric value of a logging level, defaults to INFO.
980980
981981
"""
982982
self.logger = logger.getLogger("log")

docs/examples.rst

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,4 @@ Ensure your device works with this simple test.
55

66
.. literalinclude:: ../examples/minimqtt_simpletest.py
77
:caption: examples/minimqtt_simpletest.py
8-
:linenos:
9-
10-
Basic forever loop
11-
------------------
12-
13-
This example shows how to write a loop that runs forever
14-
& can handle disconnect/re-connect events.
15-
16-
.. literalinclude:: ../examples/minimqtt_pub_sub_blocking.py
17-
:caption: examples/minimqtt_pub_sub_blocking.py
18-
:linenos:
8+
:linenos:

0 commit comments

Comments
 (0)