Skip to content

Commit 2fc81df

Browse files
committed
Update comments and docstrings
1 parent 9c43337 commit 2fc81df

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

ciscosparkapi/restsession.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,27 @@ def _fix_next_url(next_url):
8585
return urllib.parse.urlunparse(parsed_url)
8686

8787

88+
# Main module interface
8889
class RestSession(object):
8990
"""RESTful HTTP session class for making calls to the Cisco Spark APIs."""
9091

9192
def __init__(self, access_token, base_url, timeout=None,
9293
single_request_timeout=DEFAULT_SINGLE_REQUEST_TIMEOUT,
9394
rate_limit_timeout=DEFAULT_RATE_LIMIT_TIMEOUT):
94-
"""Initialize a new RestSession object."""
95+
"""Initialize a new RestSession object.
96+
97+
Args:
98+
access_token(basestring): The Spark access token to be used for
99+
this session.
100+
base_url(basestring): The base URL that will be suffixed onto the
101+
API endpoint relative URLs to produce a callable absolute URL.
102+
timeout: [Deprecated] The timeout (seconds) for an API request.
103+
single_request_timeout(float): The timeout (seconds) for a single
104+
HTTP REST API request.
105+
rate_limit_timeout(float): Maximum time (seconds) to wait for a
106+
response with rate-limit handling.
107+
108+
"""
95109
super(RestSession, self).__init__()
96110

97111
# Initialize attributes and properties

0 commit comments

Comments
 (0)