Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2026-07-08 06:41:59 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs: modernize docstrings across the repository (#1682)

Browse Source 
Comprehensive docstring cleanup across the repository — fix Sphinx
cross-references, Python REPL continuation syntax, stale class names,
and modernize the IotBulb docstring to use the
`Module.Light`/`Module.LightPreset` interface.
This commit is contained in:
ZeliardM
2026-07-05 12:30:01 -04:00
committed by GitHub
parent 7f10a39655
commit bb27a43027
18 changed files with 136 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
kasa/iot/iotdimmer.py
View File

@@ -41,14 +41,14 @@ class IotDimmer(IotPlug):
r"""Representation of a TP-Link Smart Dimmer.
Dimmers work similarly to plugs, but provide also support for
adjusting the brightness. This class extends :class:`SmartPlug` interface.
adjusting the brightness. This class extends :class:`IotPlug` interface.
To initialize, you have to await :func:`update()` at least once.
To initialize, you have to await :meth:`update()` at least once.
This will allow accessing the properties using the exposed properties.
All changes to the device are done using awaitable methods,
which will not change the cached values,
but you must await :func:`update()` separately.
but you must await :meth:`update()` separately.
Errors reported by the device are raised as :class:`KasaException`\s,
and should be handled by the user of the library.
@@ -65,7 +65,7 @@ class IotDimmer(IotPlug):
>>> dimmer.brightness
50
Refer to :class:`SmartPlug` for the full API.
Refer to :class:`IotPlug` for the full API.
"""
DIMMER_SERVICE = "smartlife.iot.dimmer"