Skip to content

Commit

Permalink
Task description fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
luav committed Apr 28, 2018
1 parent 7d76105 commit 08899a1
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Job(name, workdir=None, args=(), timeout=0, ontimeout=False, task=None

### Task
```python
Task(name, timeout=0, onstart=None, ondone=None, params=None, stdout=sys.stdout, stderr=sys.stderr):
Task(name, onstart=None, ondone=None, onfinish=None, params=None, task=None, latency=2, stdout=sys.stdout, stderr=sys.stderr):
"""Initialize task, which is a group of jobs to be executed
Task is a managing container for Jobs
Expand All @@ -173,8 +173,8 @@ Task(name, timeout=0, onstart=None, ondone=None, params=None, stdout=sys.stdout,
CONTEXT OF THE CALLER (main process) with the single argument, the task. Default: None
ATTENTION: must be lightweight
params - additional parameters to be used in callbacks
latency: float - lock timeout in seconds: None means infinite, <= 0 means non-bocking, > 0 is the actual timeout
task: Task - optional supertask
latency: float - lock timeout in seconds: None means infinite, <= 0 means non-bocking, > 0 is the actual timeout
stdout - None or file name or PIPE for the buffered output to be APPENDED
stderr - None or file name or PIPE or STDOUT for the unbuffered error output to be APPENDED
ATTENTION: PIPE is a buffer in RAM, so do not use it if the output data is huge or unlimited
Expand Down
5 changes: 3 additions & 2 deletions mpepool.py
Original file line number Diff line number Diff line change
Expand Up @@ -213,12 +213,13 @@ def __init__(self, name, onstart=None, ondone=None, onfinish=None, params=None,
CONTEXT OF THE CALLER (main process) with the single argument, the task. Default: None
ATTENTION: must be lightweight
params - additional parameters to be used in callbacks
latency: float - lock timeout in seconds: None means infinite, <= 0 means non-bocking, > 0 is the actual timeout
task: Task - optional supertask
latency: float - lock timeout in seconds: None means infinite, <= 0 means non-bocking, > 0 is the actual timeout
stdout - None or file name or PIPE for the buffered output to be APPENDED
stderr - None or file name or PIPE or STDOUT for the unbuffered error output to be APPENDED
ATTENTION: PIPE is a buffer in RAM, so do not use it if the output data is huge or unlimited
# Automatically initialized and updated properties
tstart - start time is filled automatically on the execution start (before onstart). Default: None
tstop - termination / completion time after ondone.
numadded: uint - the number of direct added subtasks
Expand Down

0 comments on commit 08899a1

Please sign in to comment.