Skip to content

Commit 3a9fefc

Browse files
committed
fix some references
1 parent 6dd64ff commit 3a9fefc

File tree

4 files changed

+8
-7
lines changed

4 files changed

+8
-7
lines changed

docs/examples/cascading_failure.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,14 +128,14 @@ affect for that and just add it to line number 5 at time 1.0.
128128
=#
129129
trip_first_cb = PresetTimeComponentCallback(1.0, affect)
130130
add_callback!(nw[EIndex(5)], trip_first_cb)
131-
nothing
131+
nothing #hide #md
132132
#=
133133
When we inspect the edge model for 5 no, we see that we've registered 2 callbacks:
134134
=#
135135
nw[EIndex(5)]
136136

137137
#=
138-
Now we can simulate the network. We use [`get_callbacks(::Networl)`](@ref)
138+
Now we can simulate the network. We use [`get_callbacks(::Network)`](@ref)
139139
to generate a callback set for the whole network which represents all of the individual
140140
component callbacks.
141141
=#

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ links = InterLinks(
1111
"DiffEq" => "https://docs.sciml.ai/DiffEqDocs/stable/",
1212
"MTK" => "https://docs.sciml.ai/ModelingToolkit/stable/",
1313
"SymbolicIndexingInterface" => "https://docs.sciml.ai/SymbolicIndexingInterface/stable/",
14+
"DiffEqCallbacks" => "https://docs.sciml.ai/DiffEqCallbacks/stable/",
1415
)
1516

1617
# generate examples

docs/src/callbacks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The "normal" [`ContinousComponentCallback`](@ref) and [`DiscreteComponentCallbac
2525
In contrast, the "vector" version has an in-place condition which writes `len` outputs. When any of those outputs hits zero, the affect is triggered with an additional argument `event_idx` which tells the effect which dimension encountered the zerocrossing.
2626

2727
There is a special type [`PresetTimeComponentCallback`](@ref) which has no explicit condition and triggers the affect at given times.
28-
This internally generates a [`PresetTimeCallback`](@ref DiffEqCallbacks.PresetTimeCallback) object from `DiffEqCallbacks.jl`.
28+
This internally generates a [`PresetTimeCallback`](@extref DiffEqCallbacks.PresetTimeCallback) object from `DiffEqCallbacks.jl`.
2929

3030

3131
### Defining the Callback
@@ -121,8 +121,8 @@ Please not a few important things here:
121121
often. By using [`SII.getsym`](@extref `SymbolicIndexingInterface.getsym`) we did
122122
some of the work *before* the callback by creating the accessor function.
123123
When handling with "normal states" and parameters consider using
124-
[`SII.variable_index`](@ref `SymbolicIndexingInterface.variable_index`) and
125-
[`SII.parameter_index`](@ref `SymbolicIndexingInterface.parameter_index`) for
124+
[`SII.variable_index`](@extref `SymbolicIndexingInterface.variable_index`) and
125+
[`SII.parameter_index`](@extref `SymbolicIndexingInterface.parameter_index`) for
126126
even better access patterns.
127127
- `t` refers to the current time of the zerocrossing-detection-algorithm. This is different from `integrator.t` which refers to the current timestep in which the zerocross-detectio takes place..
128128

src/callbacks.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ abstract type ComponentCallback end
2121
Creates a callback condition for a [`ComponentCallback`].
2222
- `f`: The condition function. Must be a function of the form `out=f(u, p, t)`
2323
when used for [`ContinousComponentCallback`](@ref) or
24-
[`DiscreteComponentcallback`](@ref) and `f!(out, u, p, t)` when used for
24+
[`DiscreteComponentCallback`](@ref) and `f!(out, u, p, t)` when used for
2525
[`VectorContinousComponentCallback`](@ref).
2626
- Arguments of `f`
2727
- `u`: The current value of the selecte `sym` states, provided as a [`SymbolicView`](@ref) object.
@@ -179,7 +179,7 @@ Tirgger a [`ComponentAffect`](@ref) at given timesteps `ts` in discrete
179179
callback, which can be attached to a component model using
180180
[`add_callback!`](@ref) or [`set_callback!`](@ref).
181181
182-
The `kwargs` will be forwarded to the [`PresetTimeCallback`](@ref DiffEqCallbacks.PresetTimeCallback)
182+
The `kwargs` will be forwarded to the [`PresetTimeCallback`](@extref DiffEqCallbacks.PresetTimeCallback)
183183
when the component based callbacks are collected for the whole network using
184184
[`get_callbacks(::Network)`](@ref).
185185

0 commit comments

Comments
 (0)