docs: more comments
This commit is contained in:
@@ -42,9 +42,19 @@ APP_VERSION = "5.09.21"
|
|||||||
|
|
||||||
|
|
||||||
class CrossFitBooker:
|
class CrossFitBooker:
|
||||||
|
"""
|
||||||
|
A class for automating the booking of CrossFit sessions.
|
||||||
|
|
||||||
|
This class handles authentication, session availability checking,
|
||||||
|
booking, and notifications for CrossFit sessions.
|
||||||
|
"""
|
||||||
|
|
||||||
def __init__(self) -> None:
|
def __init__(self) -> None:
|
||||||
"""
|
"""
|
||||||
Initialize the CrossFitBooker with necessary attributes.
|
Initialize the CrossFitBooker with necessary attributes.
|
||||||
|
|
||||||
|
Sets up authentication tokens, session headers, mandatory parameters,
|
||||||
|
and initializes the SessionNotifier for sending notifications.
|
||||||
"""
|
"""
|
||||||
self.auth_token: Optional[str] = None
|
self.auth_token: Optional[str] = None
|
||||||
self.user_id: Optional[str] = None
|
self.user_id: Optional[str] = None
|
||||||
@@ -543,4 +553,4 @@ class CrossFitBooker:
|
|||||||
"""
|
"""
|
||||||
logging.info("Script interrupted by user. Quitting...")
|
logging.info("Script interrupted by user. Quitting...")
|
||||||
# Add any cleanup code here
|
# Add any cleanup code here
|
||||||
exit(0)
|
exit(0)
|
||||||
|
|||||||
Reference in New Issue
Block a user