Skip to content

Commit

Permalink
docs: Updated docstrings for timeout to be float instead of int (#631)
Browse files Browse the repository at this point in the history
Fixes the docstrings for timeouts to indicate a `float` type, not `int`.
  • Loading branch information
byarmis authored Dec 14, 2022
1 parent 85706b3 commit c9b385b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion twilio/base/domain.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ class Domain(object):
Like, `api.twilio.com` or `lookups.twilio.com'.
"""

def __init__(self, twilio):
"""
:param Twilio twilio:
Expand All @@ -30,7 +31,7 @@ def request(self, method, uri, params=None, data=None, headers=None,
:param object data: The request body.
:param dict headers: The HTTP headers.
:param tuple auth: Basic auth tuple of (username, password)
:param int timeout: The request timeout.
:param float timeout: The request timeout.
:param bool allow_redirects: True if the client should follow HTTP
redirects.
"""
Expand Down
4 changes: 2 additions & 2 deletions twilio/http/http_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ def __init__(self, pool_connections=True, request_hooks=None, timeout=None, logg
:param bool pool_connections
:param request_hooks
:param int timeout: Timeout for the requests.
Timeout should never be zero (0) or less.
:param float timeout: Timeout for the requests.
Timeout should never be zero (0) or less.
:param logger
:param dict proxy: Http proxy for the requests session
:param int max_retries: Maximum number of retries each request should attempt
Expand Down

0 comments on commit c9b385b

Please sign in to comment.