Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add spellcheck CI #295

Merged
merged 2 commits into from
Nov 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/SpellCheck.yml
Original file line number Diff line number Diff line change
@@ -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/typos@v1.16.23
2 changes: 2 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[default.extend-words]
SER = "SER"
2 changes: 1 addition & 1 deletion docs/src/solvers/NonlinearSystemSolvers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/broyden.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/lbroyden.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/linesearch.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion test/basictests.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down