Permalink
Browse files

Minor doc clarification

  • Loading branch information...
1 parent 09046f6 commit 6cfc578c2a3599ca4a78d85f4965c78333b47f7e @bitprophet bitprophet committed Dec 10, 2012
Showing with 4 additions and 2 deletions.
  1. +4 −2 fabric/tasks.py
View
@@ -233,8 +233,10 @@ def execute(task, *args, **kwargs):
taskname:host=hostname``.
Any other arguments or keyword arguments will be passed verbatim into
- ``task`` when it is called, so ``execute(mytask, 'arg1', kwarg1='value')``
- will (once per host) invoke ``mytask('arg1', kwarg1='value')``.
+ ``task`` (the function itself -- not the ``@task`` decorator wrapping your
+ function!) when it is called, so ``execute(mytask, 'arg1',
+ kwarg1='value')`` will (once per host) invoke ``mytask('arg1',
+ kwarg1='value')``.
This function returns a dictionary mapping host strings to the given task's
return value for that host's execution run. For example, ``execute(foo,

0 comments on commit 6cfc578

Please sign in to comment.