Skip to content

Commit

Permalink
Documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
eerimoq committed May 11, 2019
1 parent 46b24e0 commit 13f17f7
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions mqttools/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -240,8 +240,9 @@ def messages(self):

async def start(self, resume_session=False):
"""Open a TCP connection to the broker and perform the MQTT connect
procedure. This method must be called before any `publish()`
or `subscribe()` calls. Call `stop()` to close the connection.
procedure. This method must be called before any
:meth:`publish()` or :meth:`subscribe()` calls. Call
:meth:`stop()` to close the connection.
If `resume_session` is ``True``, the client tries to resume
the last session in the broker. A :class:`SessionResumeError`
Expand Down Expand Up @@ -295,8 +296,8 @@ async def start(self, resume_session=False):

async def stop(self):
"""Try to cleanly disconnect from the broker and then close the TCP
connection. Call `start()` after `stop()` to reconnect to the
broker.
connection. Call :meth:`start()` after :meth:`stop()` to
reconnect to the broker.
>>> await client.stop()
Expand Down

0 comments on commit 13f17f7

Please sign in to comment.