add docstrings everywhere

Author: iiPythonx

nightwatch/bot/client.py

@@ -17,13 +17,15 @@ class AuthorizationFailed(Exception):
 
 # Handle state
 class ClientState:
+    """The current client state. Includes data such as the user list, chat logs, and websocket connection."""
     def __init__(self) -> None:
         self.user_list: list[User]
         self.chat_logs: list[Message]
         self.rics_info: dict[str, str]
         self.socket   : ClientConnection
 
 class Context:
+    """An object to store data about the current event context."""
     def __init__(
         self,
         state: ClientState,
@@ -54,21 +56,26 @@ def __repr__(self) -> str:
 
 # Main client class
 class Client:
+    """The main client class, override events on this class and call :run: to start the client."""
     def __init__(self) -> None:
         self.__state = ClientState()
         self.__session = requests.Session()
 
     # Events (for overwriting)
     async def on_connect(self, ctx: Context) -> None:
+        """Listen to the :connect: event."""
         pass
 
     async def on_message(self, ctx: Context) -> None:
+        """Listen to the :message: event."""
         pass
 
     async def on_join(self, ctx: Context) -> None:
+        """Listen to the :join: event."""
         pass
 
     async def on_leave(self, ctx: Context) -> None:
+        """Listen to the :leave: event."""
         pass
 
     # Handle running

nightwatch/bot/types.py

@@ -28,27 +28,38 @@ def from_dict(cls: typing.Type[T], data: dict) -> T:
 @dataclass
 class User:
     name: str
+    """The name of this user."""
     hex: str
+    """The hex color code of this user, without a leading hashtag."""
     admin: bool
+    """Status of whether or not this user is an admin."""
     bot: bool
+    """Status of whether or not this user is a bot."""
 
     def __repr__(self) -> str:
         return f"<User name='{self.name}' hex='{self.hex}' admin={self.admin} bot={self.bot}>"
 
 @dataclass
 class Message:
     user: User
+    """The :User: object who sent this message."""
     message: str
+    """The raw text content of this message."""
     time: int
+    """The time this message was sent in seconds since the epoch."""
 
     def __repr__(self) -> str:
         return f"<Message user='{self.user}' message='{self.message}' time={self.time}>"
 
 @dataclass
 class RicsInfo:
     name: str
+    """The name of the RICS server we are connected to."""
     users: list[User]
+    """List of :User: objects that are connected to this server."""
     chat_logs: list[Message]
+    """List of :Message: objects consisting of chat logs.
+    This will be the last 25 messages sent if you just joined, otherwise it will build over time."""
 
     def __repr__(self) -> str:
         return f"<RicsInfo name='{self.name}' users=[...] chat_logs=[...]>"