Skip to content

Commit 08933b5

Browse files
Merge pull request #194 from staticfloat/patch-1
Fix docstring
2 parents 8ab9fce + 1a1e075 commit 08933b5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/saving.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -330,8 +330,8 @@ function with_cache(f::Function, cache::CachePool{T}) where {T}
330330
end
331331

332332
"""
333-
IndependentlyLinearizingSavingCallback(ils::IndependentlyLinearizedSolution)
334-
IndependentlyLinearizingSavingCallback(ilss::Vector{IndependentlyLinearizedSolution})
333+
LinearizingSavingCallback(ils::IndependentlyLinearizedSolution)
334+
LinearizingSavingCallback(ilss::Vector{IndependentlyLinearizedSolution})
335335
336336
Provides a saving callback that inserts interpolation points into your signal such that
337337
a naive linear interpolation of the resultant saved values will be within `abstol`/`reltol`
@@ -346,8 +346,8 @@ interpolations up to the 4th order, higher orders may need more points to ensure
346346
fit. This has not been implemented yet.
347347
348348
This callback generator takes in an `IndependentlyLinearizedSolution` object to store
349-
output into. If it is given a vector of these objects, the first stores the linearized
350-
primal, the second stores the linearized first derivative, and so on.
349+
output into. An `IndependentlyLinearizedSolution` object itself controls how many
350+
derivatives (if any) to linearize along with the primal states themselves.
351351
352352
Example usage:
353353

0 commit comments

Comments
 (0)