Skip to content

Commit 15f2bd9

Browse files
committed
Add docstring
1 parent 874ca56 commit 15f2bd9

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

loading_sdk/async_api.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,17 @@ async def async_loading_api_client(email=None, password=None):
1818

1919

2020
class AsyncLoadingApiClient:
21+
"""An async client that allows python apps to easily communicate with the loading forums web api.
22+
23+
Some methods can be used anonymously, while others require the client to be authenticated
24+
with user credentials.
25+
26+
:param email: users email address (**optional**)
27+
:type email: str
28+
:param password: users password (**optional**)
29+
:type password: str
30+
"""
31+
2132
def __init__(self):
2233
self._cookies = None
2334

0 commit comments

Comments
 (0)