Skip to content
Snippets Groups Projects
Commit e5776a46 authored by Stefan Karner's avatar Stefan Karner
Browse files

Update docstrings in webarchiv.py

parent 69a2b582
No related branches found
No related tags found
No related merge requests found
......@@ -117,14 +117,13 @@ class WebarchivSession:
def fulltext_search(self, query_string, from_=None, to_=None):
"""
Start a fulltext search query in the Webarchive.
The current status of running queries can be read via status_open_queries().
:param query_string: String to search for
:param from_: Optional earliest date bound for the search
in the format YYYYMM.
:param to_: Optional latest date bound for the search
in the format YYYYMM.
:return: None
:return: HTTP Response object
"""
params = {'q': query_string}
if from_:
......@@ -143,14 +142,13 @@ class WebarchivSession:
def wayback_search(self, query_string, from_=None, to_=None):
"""
Start a wayback search query in the Webarchive.
The current status of running queries can be read via status_open_queries().
:param query_string: String to search for
:param from_: Optional earliest date bound for the search
in the format YYYYMM.
:param to_: Optional latest date bound for the search
in the format YYYYMM.
:return: None
:return: HTTP Response object
"""
params = {'q': query_string}
if from_:
......@@ -201,7 +199,6 @@ class WebarchivSession:
def domain_name_search(self, query_string, page_=1, pagesize_=100):
"""
Start a domain name search in the Webarchive.
The current status of running queries can be read via status_open_queries().
:param query_string: String to search for
:param page_: The page number parameter works with the page size parameter to control the offset of the records returned in the results. Default value is 1
......@@ -225,7 +222,6 @@ class WebarchivSession:
def histogram_search(self, query_string, interval_=3, from_=None, to_=None):
"""
Start a domain name search in the Webarchive.
The current status of running queries can be read via status_open_queries().
:param query_string: String to search for
:param page_: The page number parameter works with the page size parameter to control the offset of the records returned in the results. Default value is 1
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment