Merge pull request #295 from ArnoStrouwen/spellcheck

add spellcheck CI

.github/workflows/SpellCheck.yml

@@ -0,0 +1,13 @@
+name: Spell Check
+
+on: [pull_request]
+
+jobs:
+  typos-check:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v3
+      - name: Check spelling
+        uses: crate-ci/[email protected] 

.typos.toml

@@ -0,0 +1,2 @@
+[default.extend-words]
+SER = "SER"

docs/src/solvers/NonlinearSystemSolvers.md

@@ -64,7 +64,7 @@ features, but have a bit of overhead on very small problems.
     likely fail.
   - `FastShortcutNonlinearPolyalg()`: The default method. A polyalgorithm that mixes fast methods
     with fallbacks to robust methods to allow for solving easy problems quickly without sacrificing
-    robustnes on the hard problems.
+    robustness on the hard problems.
   - `GeneralBroyden()`: Generalization of Broyden's Quasi-Newton Method with Line Search and
     Automatic Jacobian Resetting. This is a fast method but unstable when the condition number of
     the Jacobian matrix is sufficiently large.

src/broyden.jl

@@ -2,7 +2,7 @@
 """
     GeneralBroyden(; max_resets = 3, linesearch = nothing, reset_tolerance = nothing)
 
-An implementation of `Broyden` with reseting and line search.
+An implementation of `Broyden` with resetting and line search.
 
 ## Arguments
 

src/lbroyden.jl

@@ -2,7 +2,7 @@
     LimitedMemoryBroyden(; max_resets::Int = 3, linesearch = nothing,
         threshold::Int = 10, reset_tolerance = nothing)
 
-An implementation of `LimitedMemoryBroyden` with reseting and line search.
+An implementation of `LimitedMemoryBroyden` with resetting and line search.
 
 ## Arguments
 

src/linesearch.jl

@@ -2,7 +2,7 @@
     LineSearch(method = nothing, autodiff = nothing, alpha = true)
 
 Wrapper over algorithms from
-[LineSeaches.jl](https://github.com/JuliaNLSolvers/LineSearches.jl/). Allows automatic
+[LineSearches.jl](https://github.com/JuliaNLSolvers/LineSearches.jl/). Allows automatic
 construction of the objective functions for the line search algorithms utilizing automatic
 differentiation for fast Vector Jacobian Products.
 

test/basictests.jl

@@ -985,7 +985,7 @@ end
     end
 end
 
-# Miscelleneous Tests
+# Miscellaneous Tests
 @testset "Custom JVP" begin
     function F(u::Vector{Float64}, p::Vector{Float64})
         Δ = Tridiagonal(-ones(99), 2 * ones(100), -ones(99))