Fix docs

Author: odow

docs/src/submodules/Utilities/overview.md

@@ -330,7 +330,7 @@ julia> MOI.set(model, MOI.VariableName(), x, "x")
 
 julia> c = MOI.add_constraint(model, 1.0 * x, MOI.LessThan(2.0));
 
-julia> MOI.modify(model, MOI.Utilities.PenaltyRelaxation(Dict(c => 2.0)))
+julia> map = MOI.modify(model, MOI.Utilities.PenaltyRelaxation(Dict(c => 2.0)));
 
 julia> print(model)
 Minimize ScalarAffineFunction{Float64}:
@@ -343,6 +343,9 @@ ScalarAffineFunction{Float64}-in-LessThan{Float64}
 
 VariableIndex-in-GreaterThan{Float64}
  v[2] >= 0.0
+
+julia> map[c]
+MathOptInterface.ScalarAffineFunction{Float64}(MathOptInterface.ScalarAffineTerm{Float64}[MathOptInterface.ScalarAffineTerm{Float64}(1.0, MathOptInterface.VariableIndex(2))], 0.0)
 ```
 
 ## Utilities.MatrixOfConstraints

src/Utilities/penalty_relaxation.jl

@@ -29,9 +29,17 @@ constraint that is being relaxed. If no value exists, the default is `default`.
 When `S` is [`MOI.LessThan`](@ref) or [`MOI.GreaterThan`](@ref), we omit `y` or
 `z` respectively as a performance optimization.
 
+## Return value
+
+`MOI.modify(model, PenaltyRelaxation())` returns a
+`Dict{MOI.ConstraintIndex,MOI.ScalarAffineFunction}` that maps constraint
+indices to a [`MOI.ScalarAffineFunction`](@ref) comprised of `y + z`. In an
+optimal solution, query the value of these functions to compute the violation of
+each constraint.
+
 ## Relax a subset of constraints
 
-To relax a subset of constraints, pass a `penalties` dictionary` and set
+To relax a subset of constraints, pass a `penalties` dictionary and set
 `default = nothing`.
 
 ## Supported constraint types