fixed missing documentation.

porplax · Apr 10, 2024 · 8bcf3a0 · 8bcf3a0
1 parent 31d6ba4
commit 8bcf3a0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "neobridge"
-version = "0.2.0"
+version = "0.2.2"
 description = "Lets you control neopixels from your PC using a board."
 authors = [
     {name = "Zayne Marsh", email = "saynemarsh9@gmail.com"},

diff --git a/src/neobridge/neobridge.py b/src/neobridge/neobridge.py
@@ -47,6 +47,11 @@ def setone(self, rgb: tuple, index: int):
         self._send_cmd({'command': Command.SET_ONE.value, 'r': rgb[0], 'g': rgb[1], 'b': rgb[2], 'index': index})
 
     def setlist(self, rgb_list: list):
+        """Gives the board a list of RGB values to set.
+            
+        Args:
+            rgb (rgb_list): RGB list to set.
+        """
         if len(rgb_list) != self.MAXIMUM_LEDS+1:
             raise IndexError(f"Misshaped list, RGB list must have length {self.MAXIMUM_LEDS+1}")
         self._send_cmd({'command': Command.SET_TO_LIST.value, 'rgb_list': rgb_list})