add entry point docstring

This commit is contained in:
2026-04-01 12:28:05 +01:00
parent f75cb98d67
commit e7fc2e67cf

View File

@@ -94,4 +94,13 @@ class Client:
def request_client_object(*, token: str, raw: bool = False) -> Client:
"""Entry point for users to request a Client object.
Args:
token (str): The authentication token for the Streamlabs Socket API.
raw (bool, optional): If True, the client will return raw event data. Defaults to False.
Returns:
Client: An instance of the Client class.
"""
return Client(token=token, raw=raw)