Skip to content

Commit fed6ced

Browse files
committed
Fix 2 typos and add a spellchecker CI.
1 parent e456f0d commit fed6ced

3 files changed

Lines changed: 16 additions & 3 deletions

File tree

.github/workflows/spell_check.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Spell Check
2+
3+
on: [pull_request, workflow_dispatch]
4+
5+
jobs:
6+
typos-check:
7+
name: Spell Check with Typos
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout Actions Repository
11+
uses: actions/checkout@v6
12+
- name: Check spelling
13+
uses: crate-ci/typos@v1.45.0

Readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Finally, a common interface also allows to easily combine existing algorithms, h
3131

3232
# Main features
3333

34-
See the [intial discussion](https://github.com/JuliaManifolds/AlgorithmsInterface.jl/discussions/1)
34+
See the [initial discussion](https://github.com/JuliaManifolds/AlgorithmsInterface.jl/discussions/1)
3535
as well as the [overview on existing things](https://github.com/JuliaManifolds/AlgorithmsInterface.jl/discussions/2)
3636

3737
## Further ideas

docs/src/stopping_criterion.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ function AlgorithmsInterface.initialize_state!(problem::SqrtProblem, algorithm::
6868
# reset the state for the algorithm
6969
state.iterate = rand()
7070
state.iteration = 0
71-
71+
7272
# reset the state for the stopping criterion
7373
state = AlgorithmsInterface.initialize_state!(
7474
problem, algorithm, algorithm.stopping_criterion, state.stopping_criterion_state
@@ -244,7 +244,7 @@ criterion = StopWhenStable(1e-8)
244244
heron_sqrt(16.0; stopping_criterion = criterion)
245245
```
246246

247-
Note that our work payed off, as we can still compose this stopping criterion with other criteria as well:
247+
Note that our work payd off, as we can still compose this stopping criterion with other criteria as well:
248248

249249
```@example Heron
250250
criterion = StopWhenStable(1e-8) | StopAfterIteration(5)

0 commit comments

Comments
 (0)