openstack
/
mistral-lib
Code Issues Proposed changes

Fixed the documentation of 'run' params 

The description of the 'context' param was inaccurate

Change-Id: I8c483102eb787dc4d4b7fcff746cb525c2e3b09a
This commit is contained in:
Ifat Afek 2018-06-27 15:10:31 +00:00
parent df04a2b5fd
commit d1ccfd0555
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
mistral_lib/actions/base.py
View File

@ -43,9 +43,10 @@ class Action(object):
def run(self, context):
"""Run action logic.
:param context: a dictionary containing contextual information like
execution identifier, workbook name and other data that may be needed
for some specific action implementations.
:param context: contains contextual information of the action.
The context includes an execution context (like execution identifier
and workflow name) and a security context with the authorization
details.
:return: Result of the action. Note that for asynchronous actions
it should always be None, however, if even it's not None it will be
ignored by a caller.