Skip to content

Commit

Permalink
rm empty return doc str
Browse files Browse the repository at this point in the history
  • Loading branch information
spencerseale committed Jul 12, 2024
1 parent f2ed5aa commit 37990bf
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions src/tiledb/cloud/dag/dag.py
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,11 @@ def running(self) -> bool:
return self._status is Status.RUNNING

def result(self, timeout: Optional[float] = None) -> _T:
"""Fetch Node return."""
"""Fetch Node return.
:param timeout: Time to wait to fetch result.
:return: Results of Node processing.
"""

if self.mode == Mode.BATCH:
with self._lifecycle_condition:
Expand Down Expand Up @@ -765,7 +769,6 @@ def add_update_callback(self, func):
Add a callback for when DAG status is updated
:param func: Function to call when DAG status is updated.
The function will be passed reference to this dag
:return:
"""
if not callable(func):
raise TypeError("func to add_update_callback must be callable")
Expand All @@ -778,7 +781,6 @@ def add_done_callback(self, func):
Add a callback for when DAG is completed
:param func: Function to call when DAG status is updated.
The function will be passed reference to this dag
:return:
"""
if not callable(func):
raise TypeError("func to add_done_callback must be callable")
Expand Down Expand Up @@ -837,17 +839,19 @@ def done(self) -> bool:
with self._lifecycle_condition:
return self._done()

def add_node_obj(self, node):
"""
Add node to DAG
def add_node_obj(self, node) -> Node:
"""Add node to DAG.
:param node: to add to dag
:return: node
:return: Node instance.
"""

with self._lifecycle_condition:
return self._add_node_internal(node)

def _add_node_internal(self, node: Node) -> Node:
"""Add node implementation. Must hold lifecycle condition."""

if self._status is not Status.NOT_STARTED:
raise RuntimeError("Cannot add nodes to a running graph")
self.nodes[node.id] = node
Expand All @@ -859,8 +863,7 @@ def _add_node_internal(self, node: Node) -> Node:
return node

def add_node(self, func_exec, *args, name=None, local_mode=True, **kwargs):
"""
Create and add a node.
"""Create and add a node.
DEPRECATED. Use `submit_local` instead.
Expand Down

0 comments on commit 37990bf

Please sign in to comment.