Skip to content

Commit e293ccd

Browse files
committed
small docstring typos
1 parent b9c9b26 commit e293ccd

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

src/interface/interface.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
_doc_init_state = """
22
state = initialize_state(problem::Problem, algorithm::Algorithm; kwargs...)
3-
state = initialize_state!(state::State, problem::Problem, algorithm::Algorithm; kwargs...)
3+
state = initialize_state!(problem::Problem, algorithm::Algorithm, state::State; kwargs...)
44
55
Initialize a [`State`](@ref) based on a [`Problem`](@ref) and an [`Algorithm`](@ref).
66
The `kwargs...` should allow to initialize for example the initial point.

src/interface/state.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ and provide corresponding `getproperty` and `setproperty!` methods.
1414
* `iteration` – the current iteration step ``k`` that is is currently performed or was last performed
1515
* `stopping_criterion_state` – a [`StoppingCriterionState`](@ref) that indicates whether an [`Algorithm`](@ref)
1616
will stop after this iteration or has stopped.
17-
* `iterate` the current iterate ``x^{(k)}```.
17+
* `iterate` the current iterate ``x^{(k)}``.
1818
1919
## Methods
2020
2121
The following methods should be implemented for a state
2222
23-
* [`increment!](@ref)`(state)`
23+
* [`increment!`](@ref)(state)
2424
"""
2525
abstract type State end
2626

src/stopping_criterion.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ Base.:|(s1::StopWhenAny, s2::StopWhenAny) = StopWhenAny(s1.criteria..., s2.crite
237237
238238
A [`StoppingCriterionState`](@ref) that groups multiple [`StoppingCriterionState`](@ref)s
239239
internally as a tuple.
240-
This is for example used in combination with [`StopWhenAny`](@ref) and [`StopWhenAny`](@ref)
240+
This is for example used in combination with [`StopWhenAny`](@ref) and [`StopWhenAll`](@ref)
241241
242242
# Constructor
243243
GroupStoppingCriterionState(c::Vector{N,StoppingCriterionState} where N)

0 commit comments

Comments
 (0)