Skip to content

Commit 154fc99

Browse files
committed
Consistency fixes
1 parent 0518210 commit 154fc99

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

dataikuapi/dss/flow.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,13 +129,14 @@ def get_source_datasets(self):
129129
"""
130130
return [self._get_object_from_graph_node(x) for x in self.get_source_computables() if x["type"] == "COMPUTABLE_DATASET"]
131131

132-
def get_successor_recipes(self, node, as_type="name"):
132+
def get_successor_recipes(self, node, as_type="dict"):
133133
"""
134134
Returns a list of recipes that are a successor of a graph node
135135
136136
:param node: Either a name or :class:`dataikuapi.dss.dataset.DSSDataset` object
137-
:return if as_type="name", list of strings, recipe names
138-
else list of :class:`dataikuapi.dss.recipe.DSSRecipe`
137+
:param as_type: How to return the successor recipes. Possible values are "dict" and "object"
138+
:return if as_type=dict, each recipes is returned as a dict containing at least "ref" and "type".
139+
if as_type=object, each computable is returned as a :class:`dataikuapi.dss.recipe.DSSRecipe`,
139140
"""
140141
if isinstance(node, DSSDataset):
141142
node = node.dataset_name
@@ -150,7 +151,10 @@ def get_successor_recipes(self, node, as_type="name"):
150151
def get_successor_computables(self, node, as_type="dict"):
151152
"""
152153
Returns a list of computables that are a successor of a given graph node
153-
Each computable is returned as a dict containing at least "ref" and "type"
154+
155+
:param as_type: How to return the successor recipes. Possible values are "dict" and "object"
156+
:return if as_type=dict, each recipes is returned as a dict containing at least "ref" and "type".
157+
if as_type=object, each computable is returned as a :class:`dataikuapi.dss.recipe.DSSRecipe`,
154158
"""
155159
if isinstance(node, DSSRecipe):
156160
node = node.recipe_name

0 commit comments

Comments
 (0)