Skip to content

Commit

Permalink
[FIXED] Parameters documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JonatanMartens committed Sep 29, 2020
1 parent dd4d1b7 commit 716b246
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion pyzeebe/worker/task_handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,12 @@ def task(self, task_type: str, exception_handler: ExceptionHandler = default_exc
variable_name: str = None):
"""Decorator to create a task
single_value (bool): If the function returns a single value (int, string, list) and not a dictionary set this to
True.
True. Default: False
variable_name (str): If single_value then this will be the variable name given to zeebe:
{ <variable_name>: <function_return_value> }
timeout (int): Maximum duration of the task in milliseconds. If the timeout is surpasses Zeebe will give up
on the job and retry it. Default: 10000
max_jobs_to_activate (int): Maximum jobs the worker will execute in parallel (of this task). Default: 32
"""
if single_value and not variable_name:
raise NoVariableNameGiven(task_type=task_type)
Expand Down

0 comments on commit 716b246

Please sign in to comment.