From 08f7d09353b50afafaace0577bb1c7baf5277f52 Mon Sep 17 00:00:00 2001 From: Paul Sokolovsky Date: Sat, 30 Jul 2016 14:47:03 +0300 Subject: [PATCH] umqtt.simple/README: Describe return value of connect(). --- umqtt.simple/README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/umqtt.simple/README.rst b/umqtt.simple/README.rst index 1f64305f..d9952a4c 100644 --- a/umqtt.simple/README.rst +++ b/umqtt.simple/README.rst @@ -46,7 +46,9 @@ API reference Taking into account API traits described above, umqtt pretty closely follows MQTT control operations, and maps them to class methods: -* ``connect()`` - Connect to a server. +* ``connect(...)`` - Connect to a server. Returns True if this connection + uses persisten session stored on a server (this will be always False if + clean_session=True argument is used (default)). * ``disconnect()`` - Disconnect from a server, release resources. * ``ping()`` - Ping server (response is processed automatically by wait_msg()). * ``publish()`` - Publish a message.