Skip to content

Commit 26b743b

Browse files
authored
Update the docstring for the choosetests function
1 parent a1c9c72 commit 26b743b

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

test/choosetests.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ const TESTNAMES = [
3333

3434
"""
3535
36-
`tests, net_on, exit_on_error, seed = choosetests(choices)` selects a set of tests to be
36+
`(; tests, net_on, exit_on_error, seed) = choosetests(choices)` selects a set of tests to be
3737
run. `choices` should be a vector of test names; if empty or set to
3838
`["all"]`, all tests are selected.
3939
4040
This function also supports "test collections": specifically, "linalg"
4141
refers to collections of tests in the correspondingly-named
4242
directories.
4343
44-
Upon return:
44+
The function returns a named tuple with the following elements:
4545
- `tests` is a vector of fully-expanded test names,
4646
- `net_on` is true if networking is available (required for some tests),
4747
- `exit_on_error` is true if an error in one test should cancel

0 commit comments

Comments
 (0)