Skip to content

Commit ba7bc85

Browse files
kellertuerlkdvos
andauthored
Apply suggestions from code review
Co-authored-by: Lukas Devos <ldevos98@gmail.com>
1 parent dff8c74 commit ba7bc85

3 files changed

Lines changed: 5 additions & 4 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
docs/build
22
docs/Manifest.toml
3+
Manifest.toml

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AlgorithmsInterface.jl
22

3-
Welcome to the Documentation of `LieGAlgorithmsInterface.jl`.
3+
Welcome to the Documentation of `AlgorithmsInterface.jl`.
44

55
```@meta
66
CurrentModule = AlgorithmsInterface

docs/src/interface.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ The interface this package provides is based on three ingredients of running an
66
consists of:
77

88
* a [`Problem`](@ref) that is to be solved and contains all information that is algorithm independent.
9-
This is _static information_ in the sense that it does not change during the runtime of the algorithm
9+
This is _static information_ in the sense that it does not change during the runtime of the algorithm.
1010
* an [`Algorithm`](@ref) that includes all of the _settings_ and _parameters_ that an algorithm.
11-
this is also information that is _static_
11+
this is also information that is _static_.
1212
* a [`State`](@ref) that contains all remaining data, especially data that might vary during the iteration,
1313
temporary caches, for example the current iteration the algorithm run is in and the current iterate, respectively.
1414

1515
The combination of the static information should be enough to initialize the varying data.
1616

1717
This general scheme is a guiding principle of the package, splitting information into _static_
18-
or _configuration_ types or data that allows to [`initialize_state`](@ref) a correspondint _variable_ data type.
18+
or _configuration_ types or data that allows to [`initialize_state`](@ref) a corresponding _variable_ data type.
1919

2020
The order of arguments is given by two ideas
2121

0 commit comments

Comments
 (0)