Skip to content

Commit c7099df

Browse files
committed
retest: few docstring fixes
1 parent ecb6dea commit c7099df

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/ReTest.jl

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,7 @@ const ArgType = Union{Module,PatternX,AbstractString,AbstractArray,Tuple,Symbol,
475475
476476
Run tests declared with [`@testset`](@ref) blocks, within modules `mod` if specified,
477477
or within all currently loaded modules otherwise.
478-
When no `pattern`s are specified, all the tests are run.
478+
Filtering `pattern`s can be specified to run only a subset of the tests.
479479
480480
### Keywords
481481
@@ -543,19 +543,19 @@ The "subject" of a testset is the concatenation of the subject of its parent `@t
543543
if any, with `"/\$description"` where `description` is the testset's description.
544544
For example:
545545
```julia
546-
@testset "a" begin # subject == "/a"
546+
@testset "a" begin # subject is "/a"
547547
@testset "b" begin # subject is "/a/b"
548548
end
549-
@testset "c\$i" for i=1:2 # subjects are "/a/c1" & "/a/c2"
549+
@testset "c\$i" for i=1:2 # subjects are "/a/c1" and "/a/c2"
550550
end
551551
end
552552
```
553553
554-
When `pattern` isa a `Regex`, a testset is guaranteed to run only when its subject
555-
matches `pattern`.
556-
Moreover, even if a testset matches (e.g. "/a" above with `pattern == r"a\$"`),
554+
When `pattern` is a `Regex`, a testset is guaranteed to run only when its subject
555+
matches `pattern`.
556+
Moreover, even if a testset matches (e.g. `"/a"` above with `pattern == r"a\$"`),
557557
its nested testsets might be filtered out if they don't also match
558-
(e.g. "a/b" doesn't match `pattern`).
558+
(e.g. `"a/b"` doesn't match `pattern`).
559559
560560
If a passed `pattern` is a string, then it is wrapped in a `Regex` with the
561561
"case-insensitive" flag, and must match literally the subjects.
@@ -583,7 +583,7 @@ of `mod`; if `sub` is also specified as `sub => subpat`, the patterns are merged
583583
i.e. this is equivalent to specifying `sub => (pattern, subpat)`.
584584
585585
!!! note
586-
this function executes each (top-level) `@testset` block using `eval` *within* the
586+
This function executes each (top-level) `@testset` block using `eval` *within* the
587587
module in which it was written (e.g. `mod`, when specified).
588588
"""
589589
function retest(@nospecialize(args::ArgType...);
@@ -593,7 +593,7 @@ function retest(@nospecialize(args::ArgType...);
593593
group::Bool=true,
594594
verbose::Real=true, # should be @nospecialize, but not supported on old Julia
595595
recursive::Bool=true,
596-
id=nothing,
596+
id::Maybe{Bool}=nothing,
597597
strict::Bool=true,
598598
dup::Bool=false,
599599
static::Maybe{Bool}=nothing,

0 commit comments

Comments
 (0)