Skip to content

Commit

Permalink
doc: timeout formatting fix-up.
Browse files Browse the repository at this point in the history
[no ci]
  • Loading branch information
veox committed Dec 24, 2017
1 parent 7ac3e38 commit 6102e74
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions krakenex/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,10 @@ def _query(self, urlpath, data, headers=None, timeout=None):
:type data: dict
:param headers: (optional) HTTPS headers
:type headers: dict
:param timeout: (optional) if not None, a `requests.HTTPError` will be
thrown after `timeout` seconds if a response has not been received
:type timeout: number
:param timeout: (optional) if not ``None``, a :py:exc:`requests.HTTPError`
will be thrown after ``timeout`` seconds if a response
has not been received
:type timeout: int or float
:returns: :py:meth:`requests.Response.json`-deserialised Python object
:raises: :py:exc:`requests.HTTPError`: if response status not successful
Expand Down Expand Up @@ -135,9 +136,10 @@ def query_public(self, method, data=None, timeout=None):
:type method: str
:param data: (optional) API request parameters
:type data: dict
:param timeout: (optional) if not None, a `requests.HTTPError` will be
thrown after `timeout` seconds if a response has not been received
:type timeout: number
:param timeout: (optional) if not ``None``, a :py:exc:`requests.HTTPError`
will be thrown after ``timeout`` seconds if a response
has not been received
:type timeout: int or float
:returns: :py:meth:`requests.Response.json`-deserialised Python object
"""
Expand All @@ -155,9 +157,10 @@ def query_private(self, method, data=None, timeout=None):
:type method: str
:param data: (optional) API request parameters
:type data: dict
:param timeout: (optional) if not None, a `requests.HTTPError` will be
thrown after `timeout` seconds if a response has not been received
:type timeout: number
:param timeout: (optional) if not ``None``, a :py:exc:`requests.HTTPError`
will be thrown after ``timeout`` seconds if a response
has not been received
:type timeout: int or float
:returns: :py:meth:`requests.Response.json`-deserialised Python object
"""
Expand Down

0 comments on commit 6102e74

Please sign in to comment.