improved pydoc

Author: spicquenot

dataikuapi/dss/dataset.py

@@ -243,7 +243,7 @@ def get_object_discussions(self):
         """
         Get a handle to manage discussions on the dataset
 
-        Returns:
-            the DSSObjectDiscussions of this dataset
+        :returns: the handle to manage discussions
+        :rtype: DSSObjectDiscussions
         """
         return DSSObjectDiscussions(self.client, self.project_key, "DATASET", self.dataset_name)

dataikuapi/dss/managedfolder.py

@@ -169,7 +169,7 @@ def get_object_discussions(self):
         """
         Get a handle to manage discussions on the managed folder
 
-        Returns:
-            the DSSObjectDiscussions of this managed folder
+        :returns: the handle to manage discussions
+        :rtype: DSSObjectDiscussions
         """
         return DSSObjectDiscussions(self.client, self.project_key, "MANAGED_FOLDER", self.odb_id)

dataikuapi/dss/notebook.py

@@ -55,7 +55,7 @@ def get_object_discussions(self):
         """
         Get a handle to manage discussions on the notebook
 
-        Returns:
-            the DSSObjectDiscussions of this notebook
+        :returns: the handle to manage discussions
+        :rtype: DSSObjectDiscussions
         """
         return DSSObjectDiscussions(self.client, self.project_key, "JUPYTER_NOTEBOOK", self.notebook_name)

dataikuapi/dss/project.py

@@ -756,8 +756,8 @@ def get_object_discussions(self):
         """
         Get a handle to manage discussions on the project
 
-        Returns:
-            the DSSObjectDiscussions of this project
+        :returns: the handle to manage discussions
+        :rtype: DSSObjectDiscussions
         """
         return DSSObjectDiscussions(self.client, self.project_key, "PROJECT", self.project_key)
 

dataikuapi/dss/recipe.py

@@ -84,8 +84,8 @@ def get_object_discussions(self):
         """
         Get a handle to manage discussions on the recipe
 
-        Returns:
-            the DSSObjectDiscussions of this recipe
+        :returns: the handle to manage discussions
+        :rtype: DSSObjectDiscussions
         """
         return DSSObjectDiscussions(self.client, self.project_key, "RECIPE", self.recipe_name)
 

dataikuapi/dss/savedmodel.py

@@ -105,7 +105,7 @@ def get_object_discussions(self):
         """
         Get a handle to manage discussions on the saved model
 
-        Returns:
-            the DSSObjectDiscussions of this saved model
+        :returns: the handle to manage discussions
+        :rtype: DSSObjectDiscussions
         """
         return DSSObjectDiscussions(self.client, self.project_key, "SAVED_MODEL", self.sm_id)

dataikuapi/dss/scenario.py

@@ -163,8 +163,8 @@ def get_object_discussions(self):
         """
         Get a handle to manage discussions on the scenario
 
-        Returns:
-            the DSSObjectDiscussions of this scenario
+        :returns: the handle to manage discussions
+        :rtype: DSSObjectDiscussions
         """
         return DSSObjectDiscussions(self.client, self.project_key, "SCENARIO", self.id)
 

dataikuapi/dss/wiki.py

@@ -188,7 +188,7 @@ def get_object_discussions(self):
         """
         Get a handle to manage discussions on the article
 
-        :returns: the discussion handle for this article
+        :returns: the handle to manage discussions
         :rtype: DSSObjectDiscussions
         """
         return DSSObjectDiscussions(self.client, self.project_key, "ARTICLE", self.article_id)

dataikuapi/dssclient.py

@@ -712,13 +712,11 @@ def get_object_discussions(self, project_key, object_type, object_id):
         """
         Get a handle to manage discussions on any object
 
-        Args:
-            the object project key
-            the object type
-            the object id
-
-        Returns:
-            the DSSObjectDiscussions of this object
+        :param str project_key: identifier of the project to access
+        :param str object_type: DSS object type
+        :param str object_id: DSS object ID
+        :returns: the handle to manage discussions
+        :rtype: DSSObjectDiscussions
         """
         return DSSObjectDiscussions(self, project_key, object_type, object_id)