Update comments

Author: curquiza

meilisearch/client.py

@@ -32,14 +32,14 @@ def create_index(self, uid, options=None):
         Parameters
         ----------
         uid: str
-            UID of the index
+            UID of the index.
         options: dict, optional
-            Options passed during index creation (ex: primaryKey)
+            Options passed during index creation (ex: primaryKey).
 
         Returns
         -------
         index : Index
-            An instance of Index containing the information of the newly created index
+            An instance of Index containing the information of the newly created index.
         Raises
         ------
         HTTPError
@@ -57,7 +57,7 @@ def get_indexes(self):
             In case of any error found here https://docs.meilisearch.com/references/#errors-status-code
         Returns
         -------
-        list
+        indexes: list
             List of indexes in dictionnary format. (e.g [{ 'uid': 'movies' 'primaryKey': 'objectID' }])
         """
         return Index.list_all(self.config)
@@ -66,6 +66,11 @@ def get_index(self, uid):
         """Get the index.
         This index should already exist.
 
+        Parameters
+        ----------
+        uid: str
+            UID of the index.
+
         Raises
         ------
         HTTPError
@@ -82,10 +87,15 @@ def index(self, uid):
         """Create an Index instance.
         This method doesn't trigger any HTTP call.
 
+        Parameters
+        ----------
+        uid: str
+            UID of the index.
+
         Returns
         -------
         index : Index
-            An Index instance
+            An Index instance.
         """
         if uid is not None:
             return Index(self.config, uid=uid)
@@ -104,7 +114,7 @@ def get_or_create_index(self, uid, options=None):
         Returns
         -------
         index : Index
-            An instance of Index containing the information of the retrieved or newly created index
+            An instance of Index containing the information of the retrieved or newly created index.
         Raises
         ------
         HTTPError
@@ -123,15 +133,16 @@ def get_all_stats(self):
 
         Get information about database size and all indexes
         https://docs.meilisearch.com/references/stats.html
+
         Returns
-        ----------
+        -------
         stats: `dict`
-            Dictionnary containing stats about your MeiliSearch instance
+            Dictionnary containing stats about your MeiliSearch instance.
         """
         return self.http.get(self.config.paths.stat)
 
     def health(self):
-        """Get health of MeiliSearch
+        """Get health of the MeiliSearch server.
 
         `204` HTTP status response when MeiliSearch is healthy.
 
@@ -143,9 +154,9 @@ def health(self):
         return self.http.get(self.config.paths.health)
 
     def get_keys(self):
-        """Get all keys created
+        """Get all keys.
 
-        Get list of all the keys that were created and all their related information.
+        Get list of all the keys.
 
         Returns
         ----------
@@ -176,7 +187,7 @@ def version(self):
         return self.get_version()
 
     def create_dump(self):
-        """Triggers the creation of a MeiliSearch dump
+        """Triggers the creation of a MeiliSearch dump.
 
         Returns
         ----------
@@ -187,15 +198,15 @@ def create_dump(self):
         return self.http.post(self.config.paths.dumps)
 
     def get_dump_status(self, uid):
-        """Retrieves the status of a MeiliSearch dump creation
+        """Retrieves the status of a MeiliSearch dump creation.
 
         Parameters
         ----------
         uid: str
-            UID of the dump
+            UID of the dump.
 
         Returns
-        ----------
+        -------
         Dump status: dict
             Information about the dump status.
             https://docs.meilisearch.com/references/dump.html#get-dump-status

meilisearch/index.py

@@ -24,9 +24,9 @@ def __init__(self, config, uid, primary_key=None):
         config : Config
             Config object containing permission and location of MeiliSearch.
         uid: str
-            Uid of the index on which to perform the index actions.
-        index_path: str
-            Index url path.
+            UID of the index on which to perform the index actions.
+        primary_key: str, optional
+            Primary-key of the index.
         """
         self.config = config
         self.http = HttpRequests(config)
@@ -44,12 +44,13 @@ def delete(self):
         return self.http.delete('{}/{}'.format(self.config.paths.index, self.uid))
 
     def update(self, **body):
-        """Update the index.
+        """Update the index primary-key.
 
         Parameters
         ----------
         body: **kwargs
             Accepts primaryKey as an updatable parameter.
+            Ex: index.update(primaryKey='name')
 
         Returns
         -------
@@ -82,7 +83,7 @@ def get_primary_key(self):
         Returns
         -------
         primary_key: str
-            String containing primary key.
+            String containing the primary key.
         """
         self.primary_key = self.fetch_info()['primaryKey']
         return self.primary_key
@@ -114,12 +115,12 @@ def create(config, uid, options=None):
 
     @staticmethod
     def list_all(config):
-        """Get all indexes
+        """Get all indexes.
 
         Returns
         -------
         indexes : list
-            List of indexes. Each index is a dictionnary.
+            List of the indexes. Each index is a dictionnary.
         Raises
         ------
         HTTPError