Skip to content

Commit 2992faa

Browse files
committed
fix docstring
1 parent 6ee8001 commit 2992faa

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/test_utils.jl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@ using Test
1616
x1::AbstractVector,
1717
x2::AbstractVector;
1818
atol=__ATOL,
19+
rtol=__RTOL,
1920
)
2021
2122
Run various consistency checks on `k` at the inputs `x0`, `x1`, and `x2`.
2223
`x0` and `x1` should be of the same length with different values, while `x0` and `x2` should
2324
be of different lengths.
2425
25-
test_interface([rng::AbstractRNG], k::Kernel, T::Type{<:AbstractVector}; atol=__ATOL)
26+
test_interface([rng::AbstractRNG], k::Kernel, T::Type{<:Real}; atol=__ATOL, rtol=__RTOL)
2627
27-
`test_interface` offers certain types of test data generation to make running these tests
28-
require less code for common input types. For example, `Vector{<:Real}`, `ColVecs{<:Real}`,
29-
and `RowVecs{<:Real}` are supported. For other input vector types, please provide the data
30-
manually.
28+
`test_interface` offers automated test data generation for kernels whose inputs are reals.
29+
This will run the tests for `Vector{<:Real}`, `Vector{Vector{<:Real}}`, `ColVecs{<:Real}`,
30+
and `RowVecs{<:Real}`. For other input vector types, please provide the data manually.
3131
"""
3232
function test_interface(
3333
k::Kernel,

0 commit comments

Comments
 (0)