docs: minor fix

agdestein · Nov 22, 2024 · cdbec55 · cdbec55
1 parent 5450736
commit cdbec55
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -2,6 +2,7 @@
 localdev = haskey(ENV, "LOCALDEV")
 
 # Get access to example dependencies
+# Those are required for running the examples and generating output
 push!(LOAD_PATH, joinpath(@__DIR__, "..", "examples"))
 
 using IncompressibleNavierStokes

diff --git a/docs/src/manual/closure.md b/docs/src/manual/closure.md
@@ -1,6 +1,6 @@
 # Neural closure models
 
-!!! note "`NeuralClorusure`"
+!!! note "`NeuralClosure`"
     These features are experimental, and require cloning
     IncompressibleNavierStokes from GitHub:
     ```sh

diff --git a/docs/src/manual/sciml.md b/docs/src/manual/sciml.md
@@ -34,7 +34,7 @@ using IncompressibleNavierStokes
 ax = range(0, 1, 101)
 setup = Setup(; x = (ax, ax), Re = 500.0)
 psolver = default_psolver(setup)
-f(u, p, t) = create_right_hand_side(setup, psolver)
+f = create_right_hand_side(setup, psolver)
 u0 = random_field(setup)
 tspan = (0.0, 1.0)     # time span where to solve.
 problem = ODEProblem(f, u0, tspan) #SciMLBase.ODEProblem
@@ -46,7 +46,7 @@ Alternatively, it is also possible to use an [in-place formulation](https://docs
 ```@example
 du = similar(u)
 t = 0.0
-f(du,u,p,t) = right_hand_side!(du, u, Ref([setup, psolver]), t)
+f!(du,u,p,t) = right_hand_side!(du, u, Ref([setup, psolver]), t)
 ```
 that is usually faster than the out-of-place formulation.