Skip to content

Commit ce611ae

Browse files
authored
Merge pull request #47 from brentru/update-docstring-callbacks
Clarify feed callback docstrings
2 parents f2f4e13 + 7107121 commit ce611ae

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

adafruit_io/adafruit_io.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,8 +205,12 @@ def _on_unsubscribe_mqtt(self, client, user_data, topic, pid):
205205
self.on_unsubscribe(self, user_data, topic, pid)
206206

207207
def add_feed_callback(self, feed_key, callback_method):
208-
"""Executes callback_method whenever a message is
209-
received on feed_key.
208+
"""Attaches a callback_method to an Adafruit IO feed.
209+
The callback_method function is called when a
210+
new value is written to the feed.
211+
212+
NOTE: The callback_method registered to this method
213+
will only execute during loop().
210214
:param str feed_key: Adafruit IO feed key.
211215
:param str callback_method: Name of callback method.
212216
@@ -218,6 +222,9 @@ def add_feed_callback(self, feed_key, callback_method):
218222
def remove_feed_callback(self, feed_key):
219223
"""Removes a previously registered callback method
220224
from executing whenever feed_key receives new data.
225+
226+
After this method is called, incoming messages
227+
call the shared on_message.
221228
:param str feed_key: Adafruit IO feed key.
222229
223230
"""

0 commit comments

Comments
 (0)