openstack
/
heat
Code Issues Proposed changes

Add code tag for from_task_with_args() docstring 

Simply adding an extra colon in the from_task_with_args docstring to
make the examples show up as code in the rendered documentation.

Co-Author: Qiming Teng
Change-Id: Ia1704a2f2517e2de2fb4f300979f63fbec0e9f7a
This commit is contained in:
matts2006 2014-07-22 12:47:22 +02:00 committed by tengqm
parent f604953985
commit 731c290df7
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
heat/engine/scheduler.py
View File

@ -472,13 +472,14 @@ class PollingTaskGroup(object):
Each argument to use should be passed as a list (or iterable) of values
such that one is passed in the corresponding position for each subtask.
The number of subtasks spawned depends on the length of the argument
lists. For example:
lists.
For example::
PollingTaskGroup.from_task_with_args(my_task,
[1, 2, 3],
alpha=['a', 'b', 'c'])
will start three TaskRunners that will run:
will start three TaskRunners that will run::
my_task(1, alpha='a')
my_task(2, alpha='b')