Skip to content

Commit bd552c6

Browse files
add job badges explanation in docs (#231)
1 parent 83938ce commit bd552c6

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/source/userguide/tree/index.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,13 @@ The view is organized in groups by ``date``, and ``date-member``. Each group has
1616

1717
Furthermore, if wrappers exist in the experiment, these will be enclosed in the ``wrappers`` folder sorted by running time. independent groups will be added for each wrapper that will contain the list of jobs included in the corresponding wrapper. This implies that a job can be repeated: once inside its ``date-member`` group and once in its wrapper group.
1818

19-
Inside each group you will find the list of jobs that belong to that group. The jobs are shown following this format: *job name* + # *job status* + ( + *queuing time* + ) + *running time*. Jobs that belong to a wrapper have also a badge with the code of the wrapper.
19+
Inside each group you will find the list of jobs that belong to that group. The jobs are shown following this format: *job name* + # *job status* + ( + *queuing time* + ) + *running time*. Additionally, each job can have multiple badges to describe them:
20+
21+
* Jobs that belong to a wrapper have also a badge with the code of the wrapper
22+
* Jobs without children dependencies will have a ``TARGET`` badge
23+
* Jobs without parents dependencies will have a ``SOURCE`` badge
24+
* Jobs that belongs to a date but not to a member will have a ``SYNC`` badge
25+
* If there are inconsistencies in the status of the job between their different sources (local/remote), a ``SUSPICIOUS`` badge will be displayed
2026

2127
The ``date-member`` folders will be displayed collapsed if all jobs inside a given folder have status COMPLETED, SUSPENDED or WAITING.
2228

0 commit comments

Comments
 (0)