fixed docstrings

zeroth-robotics · Nov 1, 2024 · 78e5669 · 78e5669
1 parent f2e2d04
commit 78e5669
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/openlch/__init__.py b/openlch/__init__.py
@@ -1,3 +1,3 @@
-__version__ = "0.8.0"
+__version__ = "0.8.3"
 
 from .hal import HAL
diff --git a/openlch/hal.py b/openlch/hal.py
@@ -287,6 +287,7 @@ def get_data(self) -> Dict[str, Dict[str, float]]:
 
             Returns:
                 Dict[str, Dict[str, float]]: A dictionary containing gyroscope and accelerometer data:
+
                     {
                         'gyro': {'x': float, 'y': float, 'z': float},  # Angular velocity in degrees/second
                         'accel': {'x': float, 'y': float, 'z': float}  # Linear acceleration in g
@@ -315,8 +316,8 @@ def upload_file(self, audio_data: bytes, format: str = "wav") -> Dict[str, Union
 
             Returns:
                 Dict[str, Union[str, bool]]: A dictionary containing:
-                    - 'audio_id': Identifier for the uploaded audio
-                    - 'success': Boolean indicating upload success
+                - 'audio_id': Identifier for the uploaded audio
+                - 'success': Boolean indicating upload success
 
             Raises:
                 Exception: If there's an error during upload
@@ -346,9 +347,10 @@ def get_recording(self) -> Tuple[bytes, str, int]:
 
             Returns:
                 Tuple[bytes, str, int]: Tuple containing:
-                    - bytes: The complete audio data
-                    - str: Audio format
-                    - int: Initial timestamp in milliseconds
+
+                - bytes: The complete audio data
+                - str: Audio format
+                - int: Initial timestamp in milliseconds
             """
             audio_data = bytearray()
             format_type = None