Skip to content

Commit 47225d9

Browse files
committed
Update comments
1 parent ca9f0c0 commit 47225d9

File tree

3 files changed

+185
-177
lines changed

3 files changed

+185
-177
lines changed

meilisearch/client.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def get_indexes(self):
5858
Returns
5959
-------
6060
indexes: list
61-
List of indexes in dictionnary format. (e.g [{ 'uid': 'movies' 'primaryKey': 'objectID' }])
61+
List of indexes in dictionary format. (e.g [{ 'uid': 'movies' 'primaryKey': 'objectID' }])
6262
"""
6363
return Index.list_all(self.config)
6464

@@ -78,7 +78,7 @@ def get_index(self, uid):
7878
Returns
7979
-------
8080
index : Index
81-
An Index instance containing the information the fetched index
81+
An Index instance containing the information the fetched index.
8282
"""
8383
index_dict = Index(self.config, uid).fetch_info()
8484
return Index(self.config, index_dict['uid'], index_dict['primaryKey'])
@@ -137,7 +137,7 @@ def get_all_stats(self):
137137
Returns
138138
-------
139139
stats: `dict`
140-
Dictionnary containing stats about your MeiliSearch instance.
140+
Dictionary containing stats about your MeiliSearch instance.
141141
"""
142142
return self.http.get(self.config.paths.stat)
143143

@@ -149,7 +149,7 @@ def health(self):
149149
Raises
150150
----------
151151
HTTPError
152-
If MeiliSearch is not healthy
152+
If MeiliSearch is not healthy.
153153
"""
154154
return self.http.get(self.config.paths.health)
155155

@@ -187,7 +187,7 @@ def version(self):
187187
return self.get_version()
188188

189189
def create_dump(self):
190-
"""Triggers the creation of a MeiliSearch dump.
190+
"""Trigger the creation of a MeiliSearch dump.
191191
192192
Returns
193193
----------
@@ -198,7 +198,7 @@ def create_dump(self):
198198
return self.http.post(self.config.paths.dumps)
199199

200200
def get_dump_status(self, uid):
201-
"""Retrieves the status of a MeiliSearch dump creation.
201+
"""Retrieve the status of a MeiliSearch dump creation.
202202
203203
Parameters
204204
----------

0 commit comments

Comments
 (0)