Adjust indentation in API docs

Author: sebromero

src/modulino/buttons.py

@@ -30,7 +30,7 @@ def set_led_status(self, a, b, c):
     Turn on or off the button LEDs according to the given status.
 
     Parameters:
-      a (bool): The status of the LED A.
+        a (bool): The status of the LED A.
       b (bool): The status of the LED B.
       c (bool): The status of the LED C.
     """
@@ -183,7 +183,7 @@ def is_pressed(self, index):
     Returns True if the button at the given index is currently pressed.
 
     Parameters:
-      index (int): The index of the button. A = 0, B = 1, C = 2.
+        index (int): The index of the button. A = 0, B = 1, C = 2.
     """
     return self._current_buttons_status[index]
 

src/modulino/buzzer.py

@@ -108,9 +108,9 @@ def tone(self, frequency, lenght_ms=0xFFFF, blocking=False):
     If blocking is set to True, the function will wait until the tone is finished.
 
     Parameters:
-      frequency: The frequency of the tone in Hz
-      lenght_ms: The duration of the tone in milliseconds
-      blocking: If set to True, the function will wait until the tone is finished
+        frequency: The frequency of the tone in Hz
+        lenght_ms: The duration of the tone in milliseconds
+        blocking: If set to True, the function will wait until the tone is finished
     """
     self.data[0:4]=frequency.to_bytes(4,'little')
     self.data[4:8]=lenght_ms.to_bytes(4,'little')

src/modulino/knob.py

@@ -126,7 +126,7 @@ def range(self, value):
     Sets the range of the encoder value.
 
     Parameters:
-      value (tuple): A tuple with two integers representing the minimum and maximum values of the range.
+        value (tuple): A tuple with two integers representing the minimum and maximum values of the range.
     """
     if(value[0] < -32768 or value[1] > 32767):
       raise ValueError("Range must be between -32768 and 32767")
@@ -152,7 +152,7 @@ def on_rotate_clockwise(self, value):
     Sets the callback for the rotate clockwise event.
 
     Parameters:
-      value (function): The function to be called when the encoder is rotated clockwise.
+        value (function): The function to be called when the encoder is rotated clockwise.
     """
     self._on_rotate_clockwise = value
 
@@ -166,7 +166,7 @@ def on_rotate_counter_clockwise(self, value):
     Sets the callback for the rotate counter clockwise event.
 
     Parameters:
-      value (function): The function to be called when the encoder is rotated counter clockwise.
+        value (function): The function to be called when the encoder is rotated counter clockwise.
     """
     self._on_rotate_counter_clockwise = value
 
@@ -180,7 +180,7 @@ def on_press(self, value):
     Sets the callback for the press event.
 
     Parameters:
-      value (function): The function to be called when the encoder is pressed.
+        value (function): The function to be called when the encoder is pressed.
     """
     self._on_press = value
 
@@ -194,7 +194,7 @@ def on_release(self, value):
     Sets the callback for the release event.
 
     Parameters:
-      value (function): The function to be called when the encoder is released.
+        value (function): The function to be called when the encoder is released.
     """
     self._on_release = value
 
@@ -211,7 +211,7 @@ def value(self, new_value):
     Sets the value of the encoder. This overrides the previous value.
 
     Parameters:
-      new_value (int): The new value of the encoder.
+        new_value (int): The new value of the encoder.
     """
     if(self._value_range != None): 
       if(new_value < self._value_range[0]) or (new_value > self._value_range[1]):

src/modulino/pixels.py

@@ -39,12 +39,12 @@ def set_range_rgb(self, index_from, index_to, r, g, b, brightness=100):
     Sets the color of the LEDs in the given range to the given RGB values.
 
     Parameters:
-      index_from (int): The starting index of the range.
-      index_to (int): The ending index (inclusive) of the range.
-      r (int): The red value of the color.
-      g (int): The green value of the color.
-      b (int): The blue value of the color.
-      brightness (int): The brightness of the LED. It should be a value between 0 and 100.
+        index_from (int): The starting index of the range.
+        index_to (int): The ending index (inclusive) of the range.
+        r (int): The red value of the color.
+        g (int): The green value of the color.
+        b (int): The blue value of the color.
+        brightness (int): The brightness of the LED. It should be a value between 0 and 100.
     """
     self.set_range_color(index_from, index_to, ModulinoColor(r, g, b), brightness)
 
@@ -53,10 +53,10 @@ def set_range_color(self, index_from, index_to, color, brightness=100):
     Sets the color of the LEDs in the given range to the given color.
 
     Parameters:
-      index_from (int): The starting index of the range.
-      index_to (int): The ending index (inclusive) of the range.
-      color (ModulinoColor): The color of the LEDs.
-      brightness (int): The brightness of the LED. It should be a value between 0 and 100.
+        index_from (int): The starting index of the range.
+        index_to (int): The ending index (inclusive) of the range.
+        color (ModulinoColor): The color of the LEDs.
+        brightness (int): The brightness of the LED. It should be a value between 0 and 100.
     """
     for i in range(index_from, index_to + 1):
       self.set_color(i, color, brightness)
@@ -66,10 +66,10 @@ def set_all_rgb(self, r, g, b, brightness=100):
     Sets the color of all the LEDs to the given RGB values.
 
     Parameters:
-      r (int): The red value of the color.
-      g (int): The green value of the color.
-      b (int): The blue value of the color.
-      brightness (int): The brightness of the LED. It should be a value between 0 and 100.
+        r (int): The red value of the color.
+        g (int): The green value of the color.
+        b (int): The blue value of the color.
+        brightness (int): The brightness of the LED. It should be a value between 0 and 100.
     """
     self.set_all_color(ModulinoColor(r, g, b), brightness)
 
@@ -78,8 +78,8 @@ def set_all_color(self, color, brightness=100):
     Sets the color of all the LEDs to the given color.
 
     Parameters:
-      color (ModulinoColor): The color of the LEDs.
-      brightness (int): The brightness of the LED. It should be a value between 0 and 100.
+        color (ModulinoColor): The color of the LEDs.
+        brightness (int): The brightness of the LED. It should be a value between 0 and 100.
     """
     self.set_range_color(0, NUM_LEDS - 1, color, brightness)
 
@@ -88,9 +88,9 @@ def set_color(self, idx, rgb : ModulinoColor , brightness=100):
     Sets the color of the given LED index to the given color.
 
     Parameters:
-      idx (int): The index of the LED.
-      rgb (ModulinoColor): The color of the LED.
-      brightness (int): The brightness of the LED. It should be a value between 0 and 100.
+        idx (int): The index of the LED.
+        rgb (ModulinoColor): The color of the LED.
+        brightness (int): The brightness of the LED. It should be a value between 0 and 100.
     """
     if idx < 0 or idx >= NUM_LEDS:
       raise ValueError(f"LED index out of range {idx} (Valid: 0..{NUM_LEDS - 1})")
@@ -105,11 +105,11 @@ def set_rgb(self, idx, r, g, b, brightness=100):
     Set the color of the given LED index to the given RGB values.
 
     Parameters:
-      idx (int): The index of the LED.
-      r (int): The red value of the color.
-      g (int): The green value of the color.
-      b (int): The blue value of the color.
-      brightness (int): The brightness of the LED. It should be a value between 0 and 100.
+        idx (int): The index of the LED.
+        r (int): The red value of the color.
+        g (int): The green value of the color.
+        b (int): The blue value of the color.
+        brightness (int): The brightness of the LED. It should be a value between 0 and 100.
     """
     self.set_color(idx, ModulinoColor(r, g, b), brightness)
 
@@ -118,7 +118,7 @@ def clear(self, idx):
     Turns off the LED at the given index.
 
     Parameters:
-      idx (int): The index of the LED.
+        idx (int): The index of the LED.
     """
     self.set_color(idx, ModulinoColor(0, 0, 0), 0)
 
@@ -131,7 +131,7 @@ def clear_all(self):
     Turns all the LEDs off.
 
     Parameters:
-      idx (int): The index of the LED
+        idx (int): The index of the LED
     """
     self.data = bytearray([0xE0] * NUM_LEDS * 4)