Skip to content
This repository was archived by the owner on Nov 23, 2025. It is now read-only.

Commit 34e4c98

Browse files
committed
Cleaning up documentation rendering.
1 parent 21c7ba7 commit 34e4c98

File tree

3 files changed

+4
-8
lines changed

3 files changed

+4
-8
lines changed

docs/api.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ class. This class defines hardware and firmware functionality for the
1717
device.
1818

1919
.. autoclass:: uoshardware.abstractions.Device
20-
:members:
2120

2221
Abstraction Layer
2322
-----------------

uoshardware/abstractions.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ class Pin:
327327

328328
@dataclass(frozen=True)
329329
class Device:
330-
"""Define an implemented UOS device dictionary."""
330+
"""Class defines hardware for an implemented UOS device."""
331331

332332
name: str
333333
interfaces: list

uoshardware/api.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,19 +57,16 @@ def get_device_definition(identity: str) -> Device | None:
5757
class UOSDevice: # dead: disable
5858
"""Class for high level object-orientated control of UOS devices.
5959
60-
:ivar __device: Device definitions as parsed from a compatible ini.
6160
:ivar identity: The type of device, this is must have a valid device in the config.
6261
:ivar address: Compliant connection string for identifying the device and interface.
63-
:ivar __device_interface: Lower level communication protocol layer.
64-
:ivar __kwargs: Connection specific / optional parameters.
6562
"""
6663

67-
__device: Device
64+
__device: Device # Device definitions as parsed from a compatible ini.
6865
identity = ""
6966
address = ""
70-
__device_interface: UOSInterface
67+
__device_interface: UOSInterface # Lower level communication protocol layer.
7168
loading: Loading
72-
__kwargs: dict = {}
69+
__kwargs: dict = {} # Connection specific / optional parameters.
7370

7471
def __init__(
7572
self,

0 commit comments

Comments
 (0)