Skip to content

Commit f30c394

Browse files
authored
[docs] fix various typos (#3052)
Signed-off-by: John E <jeis4wpi@outlook.com>
1 parent 39369cf commit f30c394

11 files changed

Lines changed: 19 additions & 19 deletions

File tree

docs/src/developer/checklists.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Use this checklist when updating the version of MathOptFormat.
141141
- [ ] New sets are added to the `@enum` in `src/FileFormats/MOF/read.jl`
142142
- [ ] `set_to_moi` is defined for each set in `src/FileFormats/MOF/read.jl`
143143
- [ ] `head_name` is defined for each set in `src/FileFormats/MOF/write.jl`
144-
- [ ] A new unit test calling `_test_model_equality` is aded to
144+
- [ ] A new unit test calling `_test_model_equality` is added to
145145
`test/FileFormats/MOF/MOF.jl`
146146
147147
## Tests

src/FileFormats/NL/NLExpr.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ include("opcode.jl")
1313
"""
1414
_JULIA_TO_AMPL
1515
16-
This dictionary is manualy curated, based on the list of opcodes in `opcode.jl`.
16+
This dictionary is manually curated, based on the list of opcodes in `opcode.jl`.
1717
1818
The goal is to map Julia functions to their AMPL opcode equivalent.
1919
@@ -105,7 +105,7 @@ const _JULIA_TO_AMPL = Dict{Symbol,Int}(
105105
"""
106106
_AMPL_TO_JULIA
107107
108-
This dictionary is manualy curated, based on the list of supported opcodes
108+
This dictionary is manually curated, based on the list of supported opcodes
109109
`_JULIA_TO_AMPL`.
110110
111111
The goal is to map AMPL opcodes to their Julia equivalents. In addition, we need

src/Nonlinear/ReverseAD/forward_over_reverse.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const TAG = :ReverseAD
99
"""
1010
const MAX_CHUNK::Int = 10
1111
12-
An upper bound on the chunk sie for forward-over-reverse. Increasing this could
12+
An upper bound on the chunk size for forward-over-reverse. Increasing this could
1313
improve performance at the cost of extra memory allocation. It has been 10 for a
1414
long time, and nobody seems to have complained.
1515
"""

src/Nonlinear/ReverseAD/graph_tools.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
moi_index_to_consecutive_index::Dict{MOI.VariableIndex,Int},
1111
)
1212
13-
Return a new `Vector{Nonlinear.Node}` where all occurences of
13+
Return a new `Vector{Nonlinear.Node}` where all occurrences of
1414
`NODE_MOI_VARIABLE` are replaced by `NODE_VARIABLE` that is 1-indexed and
1515
ordered.
1616
"""

src/Nonlinear/SymbolicAD/SymbolicAD.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ Return an expression representing the partial derivative of `f` with respect to
456456
## Expression swelling
457457
458458
With few exceptions, the algorithm used to compute the derivative does not
459-
perform simplications. As a result, the returned expression may contain terms
459+
perform simplifications. As a result, the returned expression may contain terms
460460
like `*(false, g)` that can be trivially simplified to `false`.
461461
462462
In most cases, you should call `simplify!(derivative(f, x))` to return a

src/Test/test_linear.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2059,7 +2059,7 @@ st w + z == 1
20592059
w, z >= 0
20602060
sol: z = 1, w = 0
20612061
```
2062-
Then it tranforms problem into:
2062+
Then it transforms problem into:
20632063
```
20642064
min x + y
20652065
st x + y >= 1

src/Utilities/matrix_of_constraints.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -608,7 +608,7 @@ function_constants(b::Vector, rows) = b[rows]
608608
set_with_dimension(::Type{S}, dim) where {S<:MOI.AbstractVectorSet}
609609
610610
Returns the instance of `S` of [`MOI.dimension`](@ref) `dim`.
611-
This needs to be implemented for sets of type `S` to be useable with
611+
This needs to be implemented for sets of type `S` to be usable with
612612
[`MatrixOfConstraints`](@ref).
613613
"""
614614
function set_with_dimension(::Type{S}, dim) where {S<:MOI.AbstractVectorSet}

src/Utilities/results.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"""
2020
is_ray(status::MOI.ResultStatusCode)
2121
22-
Returnn `true` if `status` is `INFEASIBILITY_CERTIFICATE` or
22+
Return `true` if `status` is `INFEASIBILITY_CERTIFICATE` or
2323
`NEARLY_INFEASIBILITY_CERTIFICATE`.
2424
"""
2525
function is_ray(status::MOI.ResultStatusCode)

src/attributes.jl

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1667,7 +1667,7 @@ solution `result_index`.
16671667
16681668
## PrimalStatus
16691669
1670-
Before quering this attribute you should first check [`PrimalStatus`](@ref) to
1670+
Before querying this attribute you should first check [`PrimalStatus`](@ref) to
16711671
confirm that a primal solution is available.
16721672
16731673
If the [`PrimalStatus`](@ref) is [`NO_SOLUTION`](@ref) the result of querying
@@ -1707,7 +1707,7 @@ the dual solution `result_index`.
17071707
17081708
## DualStatus
17091709
1710-
Before quering this attribute you should first check [`DualStatus`](@ref) to
1710+
Before querying this attribute you should first check [`DualStatus`](@ref) to
17111711
confirm that a dual solution is available.
17121712
17131713
If the [`DualStatus`](@ref) is [`NO_SOLUTION`](@ref) the result of querying
@@ -2092,7 +2092,7 @@ An [`AbstractVariableAttribute`](@ref) for the variable's primal value in result
20922092
20932093
## PrimalStatus
20942094
2095-
Before quering this attribute you should first check [`PrimalStatus`](@ref) to
2095+
Before querying this attribute you should first check [`PrimalStatus`](@ref) to
20962096
confirm that a primal solution is available.
20972097
20982098
If the [`PrimalStatus`](@ref) is [`NO_SOLUTION`](@ref) the result of querying
@@ -2183,7 +2183,7 @@ variable in result `result_index`, with respect to a basic solution.
21832183
21842184
## PrimalStatus
21852185
2186-
Before quering this attribute you should first check [`PrimalStatus`](@ref) to
2186+
Before querying this attribute you should first check [`PrimalStatus`](@ref) to
21872187
confirm that a primal solution is available.
21882188
21892189
If the [`PrimalStatus`](@ref) is [`NO_SOLUTION`](@ref) the result of querying
@@ -2386,7 +2386,7 @@ due to numerical tolerances they may not be identical.)
23862386
23872387
## PrimalStatus
23882388
2389-
Before quering this attribute you should first check [`PrimalStatus`](@ref) to
2389+
Before querying this attribute you should first check [`PrimalStatus`](@ref) to
23902390
confirm that a primal solution is available.
23912391
23922392
If the [`PrimalStatus`](@ref) is [`NO_SOLUTION`](@ref) the result of querying
@@ -2432,7 +2432,7 @@ result `result_index`.
24322432
24332433
## DualStatus
24342434
2435-
Before quering this attribute you should first check [`DualStatus`](@ref) to
2435+
Before querying this attribute you should first check [`DualStatus`](@ref) to
24362436
confirm that a dual solution is available.
24372437
24382438
If the [`DualStatus`](@ref) is [`NO_SOLUTION`](@ref) the result of querying
@@ -3386,7 +3386,7 @@ Both values are useful in different circumstances.
33863386
33873387
## DualStatus
33883388
3389-
Before quering this attribute you should first check [`DualStatus`](@ref) to
3389+
Before querying this attribute you should first check [`DualStatus`](@ref) to
33903390
confirm that a dual solution is available.
33913391
33923392
If the [`DualStatus`](@ref) is [`NO_SOLUTION`](@ref) the result of querying

src/functions.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ term_pair(t::ScalarQuadraticTerm) = term_indices(t) => coefficient(t)
200200
quadratic_terms::Vector{ScalarQuadraticTerm{T}},
201201
affine_terms::Vector{ScalarAffineTerm{T}},
202202
constant::T,
203-
) wher {T}
203+
) where {T}
204204
205205
The scalar-valued quadratic function ``\\frac{1}{2}x^\\top Q x + a^\\top x + b``,
206206
where:

0 commit comments

Comments
 (0)