Skip to content

Commit

Permalink
Address review feedback (tweak some docstrings).
Browse files Browse the repository at this point in the history
  • Loading branch information
hjoliver committed Oct 20, 2021
1 parent 85c3c35 commit 9f1dce5
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
3 changes: 3 additions & 0 deletions cylc/flow/network/resolvers.py
Original file line number Diff line number Diff line change
Expand Up @@ -715,9 +715,12 @@ def set_graph_window_extent(self, n_edge_distance):
def force_spawn_children(self, tasks, outputs, flow_num):
"""Spawn children of given task outputs.
User-facing method name: set_outputs.
Args:
tasks (list): List of identifiers, see `task globs`
outputs (list): List of outputs to spawn on
flow_num (int): Flow number to attribute the outputs.
Returns:
tuple: (outcome, message)
Expand Down
6 changes: 5 additions & 1 deletion cylc/flow/scheduler.py
Original file line number Diff line number Diff line change
Expand Up @@ -1845,7 +1845,11 @@ def command_force_trigger_tasks(self, items, reflow, flow_descr):
return self.pool.force_trigger_tasks(items, reflow, flow_descr)

def command_force_spawn_children(self, items, outputs, flow_num):
"""Force spawn task successors."""
"""Force spawn task successors.
User-facing method name: set_outputs.
"""
return self.pool.force_spawn_children(items, outputs, flow_num)

def _update_profile_info(self, category, amount, amount_format="%s"):
Expand Down
6 changes: 5 additions & 1 deletion cylc/flow/task_pool.py
Original file line number Diff line number Diff line change
Expand Up @@ -1388,7 +1388,11 @@ def match_taskdefs(
return n_warnings, task_items

def force_spawn_children(self, items, outputs, flow_num):
"""Spawn downstream children of given task outputs on user command."""
"""Spawn downstream children of given task outputs on user command.
User-facing method name: set_outputs.
"""
n_warnings, task_items = self.match_taskdefs(items)
for (_, point), taskdef in sorted(task_items.items()):
# This the upstream target task:
Expand Down

0 comments on commit 9f1dce5

Please sign in to comment.