Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2025-12-20 03:30:12 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Export modules & make sphinx happy (#334)

Browse Source
This commit is contained in:
Teemu R
2022-04-06 01:41:08 +02:00
committed by GitHub
parent d848117384
commit a39cef9a8c
6 changed files with 26 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
kasa/smartbulb.py
View File

@@ -42,7 +42,7 @@ _LOGGER = logging.getLogger(__name__)
class SmartBulb(SmartDevice):
"""Representation of a TP-Link Smart Bulb.
r"""Representation of a TP-Link Smart Bulb.
To initialize, you have to await :func:`update()` at least once.
This will allow accessing the properties using the exposed properties.
@@ -50,7 +50,7 @@ class SmartBulb(SmartDevice):
All changes to the device are done using awaitable methods,
which will not change the cached values, but you must await :func:`update()` separately.
Errors reported by the device are raised as :class:`SmartDeviceException`s,
Errors reported by the device are raised as :class:`SmartDeviceException`\s,
and should be handled by the user of the library.
Examples:
@@ -68,7 +68,7 @@ class SmartBulb(SmartDevice):
>>> print(bulb.is_on)
True
You can use the is_-prefixed properties to check for supported features
You can use the ``is_``-prefixed properties to check for supported features
>>> bulb.is_dimmable
True
>>> bulb.is_color