Skip to content

Commit 9046cd7

Browse files
fixup! docs: update documentation with new parameter indexing API and semantics
1 parent a2b9475 commit 9046cd7

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/src/api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ ParameterObservedFunction
3737
#### Parameter timeseries
3838

3939
If the index provider contains parameters that change during the course of the simulation
40-
at discrete intervals, it must implement the following methods to ensure correct
40+
at discrete time points, it must implement the following methods to ensure correct
4141
functioning of [`getu`](@ref) and [`getp`](@ref) for value providers that save the parameter
4242
timeseries. Note that there can be multiple parameter timeseries, in case different parameters
43-
change at different times.
43+
may change at different times.
4444

4545
```@docs
4646
is_timeseries_parameter

docs/src/complete_sii.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ setp(integrator, :b)(integrator, 3.0) # functionally the same as above
315315

316316
## Parameter Timeseries
317317

318-
If a solution object saves modified parameter values (such as through callbacks) during the
318+
If a solution object includes modified parameter values (such as through callbacks) during the
319319
simulation, it must implement several additional functions for correct functioning of
320320
[`getu`](@ref) and [`getp`](@ref). [`ParameterTimeseriesCollection`](@ref) helps in
321321
implementing parameter timeseries objects. The following mockup gives an example of

0 commit comments

Comments
 (0)