Skip to content

Commit 5cbb04c

Browse files
committed
Documentation tweaks.
1 parent 397c2e1 commit 5cbb04c

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

dropbox/dropbox.py

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,10 @@ def __init__(self,
152152
:type session: :class:`requests.sessions.Session`
153153
:param dict headers: Additional headers to add to requests.
154154
:param Optional[float] timeout: Maximum duration in seconds that
155-
client will wait when receiving data from server. After the timeout
156-
the client will give up on connection. If `None`, client will
157-
wait forever. Defaults to 30 seconds.
155+
client will wait for any single packet from the
156+
server. After the timeout the client will give up on
157+
connection. If `None`, client will wait forever. Defaults
158+
to 30 seconds.
158159
"""
159160
assert len(oauth2_access_token) > 0, \
160161
'OAuth2 access token cannot be empty.'
@@ -215,10 +216,11 @@ def request(self,
215216
validator specified by route.arg_type.
216217
:param request_binary: String or file pointer representing the binary
217218
payload. Use None if there is no binary payload.
218-
:param Optional[float] timeout: Maximum duration in seconds that
219-
client will wait when receiving data from server. After the timeout
220-
the client will give up on connection. If `None`, client will
221-
wait forever. Defaults to `None`.
219+
:param Optional[float] timeout: Maximum duration in seconds
220+
that client will wait for any single packet from the
221+
server. After the timeout the client will give up on
222+
connection. If `None`, client will wait forever. Defaults
223+
to `None`.
222224
:return: The route's result.
223225
"""
224226
host = route.attrs['host'] or 'api'
@@ -295,6 +297,11 @@ def request_json_object(self,
295297
client will wait when receiving data from server. After the timeout
296298
the client will give up on connection. If `None`, client will
297299
wait forever. Defaults to `None`.
300+
:param Optional[float] timeout: Maximum duration in seconds
301+
that client will wait for any single packet from the
302+
server. After the timeout the client will give up on
303+
connection. If `None`, client will wait forever. Defaults
304+
to `None`.
298305
:return: The route's result as a JSON-serializable Python object.
299306
"""
300307
serialized_arg = json.dumps(request_arg)

0 commit comments

Comments
 (0)