Skip to content

Commit 96388c5

Browse files
authored
Improves jvp docstring (#69)
1 parent cea4ddf commit 96388c5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/grad.jl

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ function _jvp(fdm, f, x::Vector{<:Number}, ẋ::Vector{<:Number})
4747
end
4848

4949
"""
50-
jvp(fdm, f, x, ẋ)
50+
jvp(fdm, f, xẋs::Tuple{Any, Any}...)
5151
5252
Compute a Jacobian-vector product with any types of arguments for which [`to_vec`](@ref)
53-
is defined.
53+
is defined. Each 2-`Tuple` in `xẋs` contains the value `x` and its tangent `ẋ`.
5454
"""
5555
function jvp(fdm, f, (x, ẋ)::Tuple{Any, Any})
5656
x_vec, vec_to_x = to_vec(x)

0 commit comments

Comments
 (0)