Skip to content

Commit 08f7d09

Browse files
committed
umqtt.simple/README: Describe return value of connect().
1 parent 20cd8e4 commit 08f7d09

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

umqtt.simple/README.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ API reference
4646
Taking into account API traits described above, umqtt pretty closely
4747
follows MQTT control operations, and maps them to class methods:
4848

49-
* ``connect()`` - Connect to a server.
49+
* ``connect(...)`` - Connect to a server. Returns True if this connection
50+
uses persisten session stored on a server (this will be always False if
51+
clean_session=True argument is used (default)).
5052
* ``disconnect()`` - Disconnect from a server, release resources.
5153
* ``ping()`` - Ping server (response is processed automatically by wait_msg()).
5254
* ``publish()`` - Publish a message.

0 commit comments

Comments
 (0)