From 10955dad72acb22826eb745c428e99ff9dbfd6cd Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Mon, 3 Apr 2023 01:29:41 +0200 Subject: [PATCH] Fixed some documentation glitches in `switchbot`. --- platypush/plugins/switchbot/__init__.py | 22 +++++++--------------- 1 file changed, 7 insertions(+), 15 deletions(-) diff --git a/platypush/plugins/switchbot/__init__.py b/platypush/plugins/switchbot/__init__.py index 5d750fe4b2..0adc0c8381 100644 --- a/platypush/plugins/switchbot/__init__.py +++ b/platypush/plugins/switchbot/__init__.py @@ -36,31 +36,23 @@ class SwitchbotPlugin( SwitchEntityManager, ): """ - Plugin to interact with the devices registered to a Switchbot - (https://www.switch-bot.com/) account/hub. - - The difference between this plugin and - :class:`platypush.plugins.switchbot.bluetooth.SwitchbotBluetoothPlugin` is - that the latter acts like a Bluetooth hub/bridge that interacts directly - with your Switchbot devices, while this plugin requires the devices to be - connected to a Switchbot Hub and it controls them through your cloud - account. + Plugin to interact with the devices registered to a `Switchbot`_ + account/hub. In order to use this plugin: - Set up a Switchbot Hub and configure your devices through the Switchbot app. - - Follow the steps on the `Switchbot API repo - `_ to - get an API token from the app. + - Follow the steps on `get started page`_ to get an API token from the app. + + .. _get started page: https://github.com/OpenWonderLabs/SwitchBotAPI#getting-started + .. _Switchbot: https://www.switch-bot.com/ """ def __init__(self, api_token: str, **kwargs): """ - :param api_token: API token (see - `Getting started with the Switchbot API - `_). + :param api_token: API token (see `get started page`_). """ super().__init__(**kwargs) self._api_token = api_token