Improved documentation and made minor changes

Author: samcarsonx

docs/api/commands.rst

@@ -1,14 +1,29 @@
 Commands
 ========
 
-.. automodule:: goxlr.commands.general
-   :members:
-   :undoc-members:
+Daemon
+------
+
+Used to control the daemon.
 
 .. automodule:: goxlr.commands.daemon
    :members:
    :undoc-members:
 
+GoXLR
+-----
+
+Used to set values on the GoXLR device.
+
 .. automodule:: goxlr.commands.goxlr
+   :members:
+   :undoc-members:
+   
+Status
+------
+
+Used to retrieve data from the daemon.
+
+.. automodule:: goxlr.commands.status
    :members:
    :undoc-members:

docs/api/types.rst

@@ -1,6 +1,20 @@
-Enumerators
-===========
+Models
+======
 
-.. automodule:: goxlr.types
+Enumerations
+------------
+
+Used in the API to represent a set of possible values for a given field.
+
+.. automodule:: goxlr.types.enums
+   :members:
+   :undoc-members:
+
+Dataclasses
+-----------
+
+Used in this library to represent the data returned by the API.
+
+.. automodule:: goxlr.types.models
    :members:
    :undoc-members:

goxlr/commands/goxlr.py

@@ -9,7 +9,7 @@ async def __send_command(self, payload, serial=None):
         payload = {"Command": [serial or self.serial, payload]}
         return await self.send(payload)
 
-    async def set_shutdown_commands(self, *methods):
+    async def set_shutdown_commands(self, *methods) -> dict | str:
         """
         Set the commands to be executed when the GoXLR is shutting down.
         Commands are accepted as a list of lists, where the first item is
@@ -19,12 +19,12 @@ async def set_shutdown_commands(self, *methods):
         :param methods: A list of methods to be executed when the GoXLR is shutting down.
         :type methods: list
         :return: The response from the GoXLR.
-        :rtype: dict or str
 
         :Example:
 
         >>> await xlr.set_shutdown_commands(
-        ...     ["SetFader", FaderName.A, ChannelName.Headphones]
+        ...     ["SetFader", Fader.A, Channel.Headphones],
+        ...     ["SetFader", Fader.B, Channel.Chat]
         ... )
         """
 

goxlr/commands/status.py

@@ -14,11 +14,13 @@ def __init__(self):
 
     async def get_status(self) -> Status:
         """
-        Returns the status of the GoXLR. `GoXLR.update()` should be used instead.
+        Returns the status of the GoXLR.
 
         :return: The status of the GoXLR.
 
         :raises DaemonError: If the status could not be retrieved.
+
+        :note: You should use GoXLR.update() instead of this method.
         """
         status = await self.send("GetStatus")
 

goxlr/socket.py

@@ -85,12 +85,14 @@ async def receive(self, id=None):
         If no ID is specified, it will wait for the first response and will
         not add it to the queue.
 
-        To specifically wait for a heartbeat response, specify an ID of 0.
-        To specifically wait for a patch response, specify an ID of 2**64 - 1.
+        To wait for a heartbeat response, specify an ID of 0.
+        To wait for a patch response, specify an ID of 2**64 - 1.
 
         :param id: The ID of the response to wait for.
 
         :return: The response from the daemon.
+
+        :raises: `DaemonError` if the daemon returns an error.
         """
         if not id:
             response = await self.socket.recv()
@@ -169,10 +171,17 @@ async def ping(self):
 
     async def update(self):
         """
-        Gets the latest data from the GoXLR Utility daemon and
-        updates the status and mixers attributes.
+        Gets the latest data from the GoXLR Utility daemon and updates the status
+        and mixers attributes.
 
         :return: The status of the daemon.
+
+        :raises DaemonError: If the daemon is not running.
+        :raises MixerNotFoundError: If the specified mixer is not found.
+
+        :note: This method is automatically called when the class is instantiated.
+        You should manually call this method periodically to ensure that the data
+        is up to date.
         """
         self.status = await self.get_status()
 
@@ -189,6 +198,9 @@ def select_mixer(self, serial: str = None):
                        If not specified, it will default to the first mixer.
 
         :return: The selected mixer.
+
+        :raises DaemonError: If no mixers are found.
+        :raises MixerNotFoundError: If the specified mixer is not found.
         """
 
         # set self.serial to serial if specified. if None, default to first mixer
@@ -209,6 +221,10 @@ def select_mixer(self, serial: str = None):
     async def connect(self):
         """
         Connects to the GoXLR Utility daemon and gets the latest data.
+
+        :return: True if the connection was successful, False otherwise.
+
+        :raises DaemonError: If no mixers are found.
         """
         connected = await super().connect()
         if connected: