Update docs for newer devices and DeviceConfig (#614)

* Update docs for newer devices and DeviceConfig

* Tweak docs post review

* Move sentence to newline

* Update post review

* Update following review
This commit is contained in:
Steven B
2024-01-10 19:13:14 +00:00
committed by GitHub
parent 897db674c2
commit 3e0cd07b7c
11 changed files with 163 additions and 36 deletions

View File

@@ -247,7 +247,7 @@ class SmartDevice:
@property
def credentials_hash(self) -> Optional[str]:
"""Return the connection parameters the device is using."""
"""The protocol specific hash of the credentials the device is using."""
return self.protocol._transport.credentials_hash
def add_module(self, name: str, module: Module):
@@ -804,7 +804,7 @@ class SmartDevice:
@property
def config(self) -> DeviceConfig:
"""Return the connection parameters the device is using."""
"""Return the device configuration."""
return self.protocol.config
@staticmethod