Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 282a5dc

Browse files
committed
Update documentation
1 parent 8043dc4 commit 282a5dc

2 files changed

Lines changed: 20 additions & 17 deletions

File tree

docs/arrays.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,24 +29,27 @@ When a task is started then the following environment variables are created:
2929
* HQ_TASK_ID - Task id
3030

3131

32-
## Tasks states
32+
## Task states
3333

34-
Each task has its own individual state as defined in the previous chapter.
35-
The number of tasks with each state can be seen by:
34+
Each task has its own individual state as defined in the [previous chapter](jobs.md).
35+
The number of tasks with each state can be displayed by the following command:
3636

3737
``$ hq job <job_id>``
3838

39-
State of each task can be seen:
39+
Detailed state of each task will also be included if you pass the `--tasks` flag:
4040

4141
``$ hq job <job_id> --tasks``
4242

43-
A global job state for summary outputs is derived as following (when a rule is matched, the rest is ignored):
43+
A global job state for summary outputs is derived from the state of its tasks by the first rule that matches from the
44+
following list of rules:
4445

45-
* If at least one task is in state "Running" then job state is "Running".
46-
* If at least one task is in state "Canceled" then job state is "Canceled".
47-
* If at least one task is in state "Failed" then job state is "Failed".
48-
* If at least all tasks are in state "Finished" then job state is "Finished".
49-
* Otherwise the job state is "Waiting".
46+
47+
1. If at least one task is in state "Running", then job state is "Running".
48+
2. If at least one task has not been computed yet, then job state is "Waiting".
49+
A task has been computed once it has reached the `canceled`, `failed` or `finished` state.
50+
3. If at least one task is in state "Canceled" then job state is "Canceled".
51+
4. If at least one task is in state "Failed" then job state is "Failed".
52+
5. All tasks have to be in state "Finished", therefore the job state will also be "Finished".
5053

5154

5255
## Task fail in array job

docs/jobs.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,18 +116,18 @@ Running-----------------|
116116
Finished Failed Canceled
117117
```
118118

119-
* *Submitted* - Only an informative state that a submission was successfull; it is immediately changed into "Waiting" state.
120-
* *Waiting* - The task is waiting for start
119+
* *Submitted* - Only an informative state that a submission was successful; it is only shown immediately after a submit.
120+
* *Waiting* - The task is waiting to be executed.
121121
* *Running* - The task is running in a worker. It may become "waiting" again when a worker (where the task is running) is lost.
122-
* *Finished* - The task was sucessfully finished.
123-
* *Failed* - The task failed. The error can be shown by ``hq job <job-id>``.
124-
* *Canceled* - The task was canceled by a user.
122+
* *Finished* - The task has successfully finished.
123+
* *Failed* - The task has failed. The error can be shown by ``hq job <job-id>``.
124+
* *Canceled* - The task has been canceled by a user.
125125

126126

127127
## Job states
128128

129-
In simple jobs, job state correspondes directly to the state of its a single task. In case of task arrays, see the chapter about task arrays.
130-
129+
In simple jobs, job state corresponds directly to the state of its single task. In the case of task arrays, see the chapter
130+
about [task arrays](arrays.md).
131131

132132
## Canceling jobs
133133

0 commit comments

Comments
 (0)