Skip to content

Commit 91faed7

Browse files
author
brentru
committed
more verbose qos docstring
1 parent 10177a6 commit 91faed7

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

adafruit_minimqtt/adafruit_minimqtt.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -665,11 +665,13 @@ def subscribe(self, topic, qos=0):
665665
666666
:param str,tuple,list topic: Unique MQTT topic identifier string. If
667667
this is a `tuple`, then the tuple should contain topic identifier
668-
string and qos level integer. If this is a `list`, then each list
669-
element should be a tuple containing a topic identifier string and
670-
qos level integer.
671-
:param int qos: Quality of Service level for the topic, defaults to zero.
672-
.. note:: Only options ``1`` or ``0`` are QoS levels supported by this library.
668+
string and qos level integer. If this is a `list`, then each list
669+
element should be a tuple containing a topic identifier string and
670+
qos level integer.
671+
:param int qos: Quality of Service level for the topic, defaults to
672+
zero. Conventional options are ``0`` (send at most once), ``1``
673+
(send at least once), or ``2`` (send exactly once).
674+
.. note:: Only options ``1`` or ``0`` are QoS levels supported by this library.
673675
674676
"""
675677
self.is_connected()

0 commit comments

Comments
 (0)