Skip to content

Commit 38f0d99

Browse files
lahwaaczKobzol
authored andcommitted
Fix docs formatting
1 parent a1e780c commit 38f0d99

File tree

2 files changed

+33
-33
lines changed

2 files changed

+33
-33
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -624,7 +624,7 @@ would pass `OMP_NUM_THREADS=4` to the executed `<program>`.
624624
is `hq submit`, which is now a shortcut for `hq job submit`. Here is a table of changed commands:
625625

626626
| **Previous command** | **New command** |
627-
|----------------------|--------------------|
627+
|----------------------|--------------------|
628628
| `hq jobs` | `hq job list` |
629629
| `hq job` | `hq job info` |
630630
| `hq resubmit` | `hq job resubmit` |

docs/jobs/jobs.md

+32-32
Original file line numberDiff line numberDiff line change
@@ -131,14 +131,14 @@ job.
131131
- **Time Limit** is the maximal running time of a task. If it is reached, the task will be terminated, and it will
132132
transition into the `Failed` [state](#task-state). This setting has no impact on scheduling.
133133

134-
This can serve as a sanity check to make sure that some task will not run indefinitely. You can set it with the
135-
`--time-limit` option[^2]:
134+
This can serve as a sanity check to make sure that some task will not run indefinitely. You can set it with the
135+
`--time-limit` option[^2]:
136136

137137
```bash
138138
$ hq submit --time-limit=<duration> ...
139139
```
140140

141-
!!! note
141+
!!! note
142142

143143
Time limit is counted separately for each task. If you set a time limit of `3 minutes` and create two tasks,
144144
where each will run for two minutes, the time limit will not be hit.
@@ -149,16 +149,16 @@ job.
149149
this
150150
task.
151151

152-
Time requests are only used during scheduling, where the server decides which worker should execute which task.
153-
Once a task is scheduled and starts executing on a worker, the time request value will not have any effect.
152+
Time requests are only used during scheduling, where the server decides which worker should execute which task.
153+
Once a task is scheduled and starts executing on a worker, the time request value will not have any effect.
154154

155-
You can set the time request using the `--time-request` option[^2]:
155+
You can set the time request using the `--time-request` option[^2]:
156156

157-
```bash
158-
$ hq submit --time-request=<duration> ...
159-
```
157+
```bash
158+
$ hq submit --time-request=<duration> ...
159+
```
160160

161-
!!! note
161+
!!! note
162162

163163
Workers with an unknown remaining lifetime will be able to execute any task, disregarding its time request.
164164

@@ -313,7 +313,7 @@ There are three ways of waiting until a job completes:
313313
$ hq submit --wait ...
314314
```
315315
316-
!!! tip
316+
!!! tip
317317
318318
This method can be used for benchmarking the job duration.
319319
@@ -327,14 +327,14 @@ There are three ways of waiting until a job completes:
327327
- **Interactive wait** If you want to interactively observe the status of a job (which is useful especially if it
328328
has [multiple tasks](arrays.md)), you can use the `hq job progress` command:
329329
330-
=== "Submit and observe"
331-
```bash
332-
$ hq submit --progress ...
333-
```
334-
=== "Observe an existing job[^1]"
335-
```bash
336-
$ hq job progress <selector>
337-
```
330+
=== "Submit and observe"
331+
```bash
332+
$ hq submit --progress ...
333+
```
334+
=== "Observe an existing job[^1]"
335+
```bash
336+
$ hq job progress <selector>
337+
```
338338
339339
## Attaching standard input
340340
@@ -390,11 +390,11 @@ $ hq submit --stdout="out.txt:rm-if-finished" /my-program
390390
The file will not be deleted if the task fails or is cancelled.
391391
392392
!!! Note
393-
If you want to use the default `stdout`/`stderr` file path (and you don't want to look it up), you can also specify
394-
just the cleanup mode without the file path:
395-
```bash
396-
$ hq submit --stdout=":rm-if-finished" /my-program
397-
```
393+
If you want to use the default `stdout`/`stderr` file path (and you don't want to look it up), you can also specify
394+
just the cleanup mode without the file path:
395+
```bash
396+
$ hq submit --stdout=":rm-if-finished" /my-program
397+
```
398398

399399
## Useful job commands
400400

@@ -403,15 +403,15 @@ Here is a list of useful job commands:
403403
### Display job table
404404

405405
=== "List queued and running jobs"
406-
```bash
407-
$ hq job list
408-
```
406+
```bash
407+
$ hq job list
408+
```
409409
=== "List all jobs"
410-
```bash
411-
$ hq job list --all
412-
```
410+
```bash
411+
$ hq job list --all
412+
```
413413
=== "List jobs by status"
414-
You can display only jobs having the selected [states](#job-state) by using the `--filter` flag:
414+
You can display only jobs having the selected [states](#job-state) by using the `--filter` flag:
415415

416416
```bash
417417
$ hq job list --filter running,waiting
@@ -460,4 +460,4 @@ By default, this limit is `5` but it can be changed as follows:
460460
$ hq submit --crash-limit=<NEWLIMIT> ...
461461
```
462462

463-
If the limit is set to 0, then the limit is disabled.
463+
If the limit is set to 0, then the limit is disabled.

0 commit comments

Comments
 (0)