Skip to content
Snippets Groups Projects

Major docs revamp

Merged Duncan Macleod requested to merge duncanmmacleod/gwdatafind:revamp-docs into main
1 file
+ 9
9
Compare changes
  • Side-by-side
  • Inline
+ 9
9
@@ -53,7 +53,7 @@ class HTTPConnection(http_client.HTTPConnection):
port : `int`, optional
the port on which to connect.
**kwargs
kwargs
other keywords are passed directly to `http.client.HTTPConnection`
"""
def __init__(self, host=None, port=None,
@@ -82,7 +82,7 @@ class HTTPConnection(http_client.HTTPConnection):
url : `str`
remote URL to query.
**kwargs
kwargs
other keyword arguments are passed to
:meth:`http.client.HTTPConnection.request`.
@@ -113,7 +113,7 @@ class HTTPConnection(http_client.HTTPConnection):
url : `str`
remote URL to query
**kwargs
kwargs
other keyword arguments are passed to
:meth:`HTTPConnection._request_response`
@@ -145,7 +145,7 @@ class HTTPConnection(http_client.HTTPConnection):
- ``'warn'``: print warning, return empty `list`
- ``'raise'``: raise `RuntimeError`
**kwargs
kwargs
other keyword arguments are passed to
:meth:`HTTPConnection.get_json`
@@ -264,10 +264,10 @@ class HTTPConnection(http_client.HTTPConnection):
frametype : `str`
name of frametype to match
start : `int`
gpsstart : `int`
GPS start time of query
end : `int`
gpsend : `int`
GPS end time of query
Returns
@@ -290,8 +290,8 @@ class HTTPConnection(http_client.HTTPConnection):
Parameters
----------
frametype : `str`
name of frametype to match
framefile : `str`
base name of file to match
urltype : `str`, optional
file scheme to search for, one of ``'file'``, ``'gsiftp'``, or
@@ -444,7 +444,7 @@ class HTTPSConnection(http_client.HTTPSConnection, HTTPConnection):
port : `int`, optional
the port on which to connect.
**kwargs
kwargs
other keywords are passed directly to `http.client.HTTPSConnection`
"""
def __init__(self, host=None, port=None, **kwargs):
Loading