From 22edebef77942380bdd1d061dfcca2dffbbde04c Mon Sep 17 00:00:00 2001 From: brentru Date: Wed, 30 Sep 2020 12:48:32 -0400 Subject: [PATCH 1/2] clarify handlers docstrings --- adafruit_io/adafruit_io.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/adafruit_io/adafruit_io.py b/adafruit_io/adafruit_io.py index baa0994..20cec2c 100755 --- a/adafruit_io/adafruit_io.py +++ b/adafruit_io/adafruit_io.py @@ -205,8 +205,12 @@ def _on_unsubscribe_mqtt(self, client, user_data, topic, pid): self.on_unsubscribe(self, user_data, topic, pid) def add_feed_callback(self, feed_key, callback_method): - """Executes callback_method whenever a message is - received on feed_key. + """Attaches a callback_method to an Adafruit IO feed. + The callback_method function is called when a + new value is written to the feed. + + NOTE: The callback_method registered to this method + will only execute after a call to loop(). :param str feed_key: Adafruit IO feed key. :param str callback_method: Name of callback method. @@ -218,6 +222,9 @@ def add_feed_callback(self, feed_key, callback_method): def remove_feed_callback(self, feed_key): """Removes a previously registered callback method from executing whenever feed_key receives new data. + + If an on_message callback is registered, new messages + will now call on_message instead of the callback_method. :param str feed_key: Adafruit IO feed key. """ From 710712143d01404dd9f22961a8a6181477c572b2 Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 30 Oct 2020 15:56:13 -0400 Subject: [PATCH 2/2] address rewording --- adafruit_io/adafruit_io.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/adafruit_io/adafruit_io.py b/adafruit_io/adafruit_io.py index 20cec2c..cf2eba0 100755 --- a/adafruit_io/adafruit_io.py +++ b/adafruit_io/adafruit_io.py @@ -210,7 +210,7 @@ def add_feed_callback(self, feed_key, callback_method): new value is written to the feed. NOTE: The callback_method registered to this method - will only execute after a call to loop(). + will only execute during loop(). :param str feed_key: Adafruit IO feed key. :param str callback_method: Name of callback method. @@ -223,8 +223,8 @@ def remove_feed_callback(self, feed_key): """Removes a previously registered callback method from executing whenever feed_key receives new data. - If an on_message callback is registered, new messages - will now call on_message instead of the callback_method. + After this method is called, incoming messages + call the shared on_message. :param str feed_key: Adafruit IO feed key. """