Skip to content

Commit 5788bd3

Browse files
authored
Update help message in README.md, and clarify runtests arguments (#50)
1 parent 26a0984 commit 5788bd3

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,24 @@ Simple parallel test runner for Julia tests with autodiscovery.
44

55
## Usage
66

7-
```julia
8-
julia> import Pkg
7+
The main entry point of `ParallelTestRunner` is the exported function `runtests`, which takes two mandatory arguments:
8+
9+
* the module for which you want to run the tests
10+
* the list of arguments passed to the test script, as a `Vector{String}`, this will typically be [`Base.ARGS`](https://docs.julialang.org/en/v1/base/constants/#Base.ARGS).
911

10-
julia> Pkg.test("ParallelTestRunner"; test_args=["--help"])
12+
With the `--help` flag you can print a help message:
13+
14+
```julia
15+
julia> using ParallelTestRunner
1116

17+
julia> ParallelTestRunner.runtests(ParallelTestRunner, ["--help"])
1218
Usage: runtests.jl [--help] [--list] [--jobs=N] [TESTS...]
1319

1420
--help Show this text.
1521
--list List all available tests.
1622
--verbose Print more information during testing.
1723
--quickfail Fail the entire run as soon as a single test errored.
18-
--jobs=N Launch `N` processes to perform tests (default: Sys.CPU_THREADS).
24+
--jobs=N Launch `N` processes to perform tests.
1925

2026
Remaining arguments filter the tests that will be executed.
2127
```

0 commit comments

Comments
 (0)