Skip to content

Commit 74f074c

Browse files
author
brentru
committed
fix autodoc in file
1 parent 1f5d2ba commit 74f074c

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

adafruit_io/adafruit_io.py

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -209,14 +209,14 @@ def subscribe(self, feed_key=None, group_key=None, shared_user=None):
209209
:param str group_key: Adafruit IO Group key.
210210
:param str shared_user: Owner of the Adafruit IO feed, required for shared feeds.
211211
212-
Example of subscribing to an Adafruit IO Feed named 'temperature':
212+
Example of subscribing to an Adafruit IO Feed named 'temperature'.
213213
214214
.. code-block:: python
215215
216216
client.subscribe('temperature')
217217
218-
Example of subscribing to two Adafruit IO feeds: `temperature`
219-
and `humidity`
218+
Example of subscribing to two Adafruit IO feeds: 'temperature'
219+
and 'humidity'.
220220
221221
.. code-block:: python
222222
@@ -265,7 +265,7 @@ def subscribe_to_weather(self, weather_record, forecast):
265265

266266
def subscribe_to_time(self, time_type):
267267
"""Adafruit IO provides some built-in MQTT topics for getting the current server time.
268-
:param str time_type: Current Adafruit IO server time. Can be `seconds`, `millis`, or `iso`.
268+
:param str time_type: Current Adafruit IO server time. Can be 'seconds', 'millis', or 'iso'.
269269
Information about these topics can be found on the Adafruit IO MQTT API Docs.:
270270
https://io.adafruit.com/api/docs/mqtt.html#time-topics
271271
"""
@@ -283,14 +283,14 @@ def unsubscribe(self, feed_key=None, group_key=None, shared_user=None):
283283
:param str group_key: Adafruit IO Group key.
284284
:param str shared_user: Owner of the Adafruit IO feed, required for shared feeds.
285285
286-
Example of unsubscribing from a Feed:
286+
Example of unsubscribing from a feed.
287287
288288
.. code-block:: python
289289
290290
client.unsubscribe('temperature')
291291
292-
Example of unsubscribing from two feeds: `temperature`
293-
and `humidity`
292+
Example of unsubscribing from two feeds: 'temperature'
293+
and 'humidity'
294294
295295
.. code-block:: python
296296
@@ -316,6 +316,7 @@ def unsubscribe(self, feed_key=None, group_key=None, shared_user=None):
316316
def publish_multiple(self, feeds_and_data, timeout=3, is_group=False):
317317
"""Publishes multiple data points to multiple feeds or groups with a variable
318318
timeout.
319+
319320
:param str feeds_and_data: List of tuples containing topic strings and data values.
320321
:param int timeout: Delay between publishing data points to Adafruit IO, in seconds.
321322
:param bool is_group: Set to True if you're publishing to a group.
@@ -342,6 +343,7 @@ def publish_multiple(self, feeds_and_data, timeout=3, is_group=False):
342343
# pylint: disable=too-many-arguments
343344
def publish(self, feed_key, data, metadata=None, shared_user=None, is_group=False):
344345
"""Publishes to an An Adafruit IO Feed.
346+
345347
:param str feed_key: Adafruit IO Feed key.
346348
:param str data: Data to publish to the feed or group.
347349
:param int data: Data to publish to the feed or group.
@@ -417,6 +419,7 @@ class IO_HTTP:
417419
"""
418420
Client for interacting with the Adafruit IO HTTP API.
419421
https://io.adafruit.com/api/docs/#adafruit-io-http-api
422+
420423
:param str adafruit_io_username: Adafruit IO Username
421424
:param str adafruit_io_key: Adafruit IO Key
422425
:param wifi_manager: WiFiManager object from ESPSPI_WiFiManager or ESPAT_WiFiManager

0 commit comments

Comments
 (0)