Skip to content

Commit

Permalink
Update error comments
Browse files Browse the repository at this point in the history
  • Loading branch information
curquiza committed Dec 7, 2020
1 parent c1d8eab commit 1e7fba8
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 52 deletions.
22 changes: 11 additions & 11 deletions meilisearch/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ def create_index(self, uid, options=None):
Raises
------
MeiliSearchApiError
In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code
An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
"""
return Index.create(self.config, uid, options)

Expand All @@ -59,7 +59,7 @@ def get_indexes(self):
Raises
------
MeiliSearchApiError
In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code
An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
"""
return self.http.get(self.config.paths.index)

Expand All @@ -80,7 +80,7 @@ def get_index(self, uid):
Raises
------
MeiliSearchApiError
In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code
An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
"""
return Index(self.config, uid).fetch_info()

Expand Down Expand Up @@ -120,7 +120,7 @@ def get_or_create_index(self, uid, options=None):
Raises
------
MeiliSearchApiError
In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code
An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
"""
try:
index_instance = self.get_index(uid)
Expand All @@ -144,7 +144,7 @@ def get_all_stats(self):
Raises
------
MeiliSearchApiError
In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code
An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
"""
return self.http.get(self.config.paths.stat)

Expand All @@ -156,7 +156,7 @@ def health(self):
Raises
------
MeiliSearchApiError
In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code
An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
"""
return self.http.get(self.config.paths.health)

Expand All @@ -174,7 +174,7 @@ def get_keys(self):
Raises
------
MeiliSearchApiError
In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code
An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
"""
return self.http.get(self.config.paths.keys)

Expand All @@ -189,7 +189,7 @@ def get_version(self):
Raises
------
MeiliSearchApiError
In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code
An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
"""
return self.http.get(self.config.paths.version)

Expand All @@ -204,7 +204,7 @@ def version(self):
Raises
------
MeiliSearchApiError
In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code
An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
"""
return self.get_version()

Expand All @@ -220,7 +220,7 @@ def create_dump(self):
Raises
------
MeiliSearchApiError
In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code
An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
"""
return self.http.post(self.config.paths.dumps)

Expand All @@ -241,7 +241,7 @@ def get_dump_status(self, uid):
Raises
------
MeiliSearchApiError
In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code
An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
"""
return self.http.get(
self.config.paths.dumps + '/' + str(uid) + '/status'
Expand Down
Loading

0 comments on commit 1e7fba8

Please sign in to comment.