correct docs, aBS

bifurcationkit · Sep 25, 2023 · 3912546 · 3912546 · rveltz · Sep 25, 2023
1 parent 3ea12e8
commit 3912546
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 8 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -11,12 +11,10 @@ Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
 SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 Setfield = "efcf1570-3423-57d1-acb7-fd33fddbac46"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
-SparseDiffTools = "47a9eef4-7e08-11e9-0b38-333d64bd3804"
 
 [compat]
 BifurcationKit = "0.3"
 DifferentialEquations = "6.19.0, 7.1.0"
 Documenter = "0.27"
-Setfield = "0.5.0, 0.7.0, 0.8.0, ^1"
-SparseDiffTools = "1.24"
+Setfield = "0.5.0, 0.7.0, 0.8.0, 1"
 julia = "1"
diff --git a/docs/src/branchswitching.md b/docs/src/branchswitching.md
@@ -31,10 +31,10 @@ F(x, p) = [x[1] * (p.μ - x[1])]
 par = (μ = -0.2, )
 
 # problem (automatic differentiation)
-prob = BifurcationProblem(F, [0.1], par, (@lens _.μ); recordFromSolution = (x, p) -> x[1])
+prob = BifurcationProblem(F, [0.1], par, (@lens _.μ); record_from_solution = (x, p) -> x[1])
 
 # compute branch of trivial equilibria (=0) and detect a bifurcation point
-opts_br = ContinuationPar(dsmax = 0.05, ds = 0.01, detectBifurcation = 3, nev = 2)
+opts_br = ContinuationPar(dsmax = 0.05, ds = 0.01, detect_bifurcation = 3, nev = 2)
 br = continuation(prob, PALC(), opts_br)
 	
 # perform branch switching on one side of the bifurcation point
@@ -51,8 +51,7 @@ scene = plot(br, br1Top, br1Bottom; branchlabel = ["br", "br1Top", "br1Bottom"],
 We provide an automatic branch switching method in this case. The method is to first compute the reduced equation (see [Non-simple branch point](@ref)) and use it to compute the nearby solutions. These solutions are seeded as initial guess for [`continuation`](@ref). Hence, you can perform automatic branch switching by calling `continuation` with the following options:
 
 ```julia
-continuation(br::ContResult, ind_bif::Int, optionsCont::ContinuationPar;
-	kwargs...)
+continuation(br::ContResult, ind_bif::Int, optionsCont::ContinuationPar; kwargs...)
 ```
 
 An example of use is provided in [2d generalized Bratu–Gelfand problem](@ref).

diff --git a/docs/src/library.md b/docs/src/library.md
@@ -53,7 +53,7 @@ getamplitude
 ```
 
 ```@docs
-getMaximum
+getmaximum
 ```
 
 ## Misc.