Skip to content

Commit 2fd4943

Browse files
authored
More info in docstrings
1 parent ca519c6 commit 2fd4943

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/testers.jl

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ at input point `z` to confirm that there are correct `frule` and `rrule`s provid
1313
- `fkwargs` are passed to `f` as keyword arguments.
1414
- If `check_inferred=true`, then the inferrability (type-stability) of the `frule` and `rrule` are checked.
1515
- `testset_name`: if provided, the name of the testset used to wrap the tests.
16+
Otherwise it is determined from the function and argument types.
1617
- All remaining keyword arguments are passed to `isapprox`.
1718
"""
1819
function test_scalar(f, z; rtol=1e-9, atol=1e-9, fdm=_fdm, fkwargs=NamedTuple(), check_inferred=true, testset_name=nothing, kwargs...)
@@ -91,7 +92,8 @@ end
9192
- If `check_inferred=true`, then the inferrability (type-stability) of the `frule` is checked,
9293
as long as `f` is itself inferrable.
9394
- `fkwargs` are passed to `f` as keyword arguments.
94-
- `testset_name`: if provided, the name of the testset used to wrap the tests.
95+
- `testset_name`: if provided, the name of the testset used to wrap the tests.
96+
Otherwise it is determined from the function and argument types.
9597
- All remaining keyword arguments are passed to `isapprox`.
9698
"""
9799
function test_frule(args...; kwargs...)
@@ -168,7 +170,8 @@ end
168170
- If `check_inferred=true`, then the inferrability (type-stability) of the `rrule` is checked
169171
— if `f` is itself inferrable — along with the inferrability of the pullback it returns.
170172
- `fkwargs` are passed to `f` as keyword arguments.
171-
- `testset_name`: if provided, the name of the testset used to wrap the tests.
173+
- `testset_name`: if provided, the name of the testset used to wrap the tests.
174+
Otherwise it is determined from the function and argument types.
172175
- All remaining keyword arguments are passed to `isapprox`.
173176
"""
174177
function test_rrule(args...; kwargs...)

0 commit comments

Comments
 (0)