From 3795bc6fbc0709321e97fbdc772e7ea94ed72feb Mon Sep 17 00:00:00 2001 From: Pascal Schade Date: Wed, 22 Jan 2025 02:08:21 +0100 Subject: [PATCH] Add docstrings --- rosys/hardware/imu.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/rosys/hardware/imu.py b/rosys/hardware/imu.py index 0b3e7cf6..7c6b920e 100644 --- a/rosys/hardware/imu.py +++ b/rosys/hardware/imu.py @@ -29,6 +29,7 @@ class ImuMeasurement: class Imu(Module): + """A module that provides measurements from an IMU.""" def __init__(self, offset_rotation: Rotation | None = None, **kwargs) -> None: super().__init__(**kwargs) @@ -93,6 +94,7 @@ def developer_ui(self) -> None: class ImuHardware(Imu, ModuleHardware): + """A hardware module that handles the communication with an IMU.""" def __init__(self, robot_brain: RobotBrain, name: str = 'imu', **kwargs) -> None: self.name = name @@ -121,6 +123,7 @@ def handle_core_output(self, time: float, words: list[str]) -> None: class ImuSimulation(Imu, ModuleSimulation): + """Simulation of an IMU.""" def __init__(self, *, wheels: WheelsSimulation, interval: float = 0.1, roll_noise: float = 0.0, pitch_noise: float = 0.0, yaw_noise: float = 0.0, **kwargs) -> None: super().__init__(**kwargs)