Skip to content

Commit cda494c

Browse files
committed
docs: Update docstring for codeforces.api.call
1 parent 8e6f7c4 commit cda494c

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

codeforces/api.py

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,24 @@ def __generate_api_sig(method, args, secret):
2727

2828

2929
def call(method, key=None, secret=None, **kargs):
30-
"""Call a Codeforces API method"""
30+
"""
31+
Call a Codeforces API method
32+
33+
Parameters
34+
----------
35+
method: str
36+
Name of method to call, list of all methods can be found at
37+
https://codeforces.com/api/help.
38+
key: str, optional
39+
Your api key (needed for authorized calls)
40+
secret: str, optional
41+
Secret for your api key.
42+
43+
Returns
44+
-------
45+
json
46+
Returns a python object containing the results of the api call.
47+
"""
3148
args = kargs.copy()
3249

3350
if (key is not None) and (secret is not None):

0 commit comments

Comments
 (0)