Update docstrings

Author: odow

src/Utilities/functions.jl

@@ -482,6 +482,26 @@ function scalar_type(::Type{MOI.VectorQuadraticFunction{T}}) where {T}
     return MOI.ScalarQuadraticFunction{T}
 end
 
+"""
+    vector_type(::Type{<:MOI.AbstractScalarFunction})
+
+Return the [`MOI.AbstractVectorFunction`](@ref) associated with the scalar type
+`F`.
+"""
+function vector_type end
+
+vector_type(::Type{T}) where {T} = Vector{T}
+
+vector_type(::Type{MOI.VariableIndex}) = MOI.VectorOfVariables
+
+function vector_type(::Type{MOI.ScalarAffineFunction{T}}) where {T}
+    return MOI.VectorAffineFunction{T}
+end
+
+function vector_type(::Type{MOI.ScalarQuadraticFunction{T}}) where {T}
+    return MOI.VectorQuadraticFunction{T}
+end
+
 """
     ScalarFunctionIterator{F<:MOI.AbstractVectorFunction}
 
@@ -1330,19 +1350,6 @@ function operate_output_index!(
     return x[i] = operate!(op, T, x[i], args...)
 end
 
-"""
-    promote_operation(
-        op::Function,
-        ::Type{T},
-        ArgsTypes::Type{<:Union{T, MOI.AbstractFunction}}...,
-    ) where {T}
-
-Returns the type of the `MOI.AbstractFunction` returned to the call
-`operate(op, T, args...)` where the types of the arguments `args` are
-`ArgsTypes`.
-"""
-function promote_operation end
-
 # Helpers
 
 function operate_term(

src/Utilities/promote_operation.jl

@@ -4,50 +4,50 @@
 # Use of this source code is governed by an MIT-style license that can be found
 # in the LICENSE.md file or at https://opensource.org/licenses/MIT.
 
-# There are five methods for which we implement `Utilities.promote_operation`
-# and `Utilities.operate`:
-#
-#  1. `+`
-#     a. `promote_operation(::typeof(+), ::Type{T}, ::Type{F1}, ::Type{F2})`
-#  2. `-`
-#     a. `promote_operation(::typeof(-), ::Type{T}, ::Type{F})`
-#     b. `promote_operation(::typeof(-), ::Type{T}, ::Type{F1}, ::Type{F2})`
-#     c. `promote_operation(::typeof(-), ::Type{T}, ::Type{F1}, ::Type{Vector{T}})`
-#  3. `*`
-#     a. `promote_operation(::typeof(*), ::Type{T}, ::Type{T}, ::Type{F})`
-#     b. `promote_operation(::typeof(*), ::Type{T}, ::Type{F1}, ::Type{F2})`
-#        where `F1` and `F2` are `VariableIndex` or `ScalarAffineFunction`
-#     c. `promote_operation(::typeof(*), ::Type{T}, ::Type{<:Diagonal{T}}, ::Type{F}`
-#  4. `/`
-#     a. `promote_operation(::typeof(/), ::Type{T}, ::Type{F}, ::Type{T})`
-#  5. `vcat`
-#     a. `promote_operation(::typeof(vcat), ::Type{T}, ::Type{F}...)`
-#  6. `imag`
-#     a. `promote_operation(::typeof(imag), ::Type{T}, ::Type{F}`
-#        where `F` is `VariableIndex` or `VectorOfVariables`
-#
-# There are eight types:
-#
-#  1. ::T
-#  2. ::VariableIndex
-#  3. ::ScalarAffineFunction{T}
-#  4. ::ScalarQuadraticFunction{T}
-#  5. ::AbstractVector{T}
-#  6. ::VectorOfVariables
-#  7. ::VectorAffineFunction{T}
-#  8. ::VectorQuadraticFunction{T}
-
-vector_type(::Type{T}) where {T} = Vector{T}
-
-vector_type(::Type{MOI.VariableIndex}) = MOI.VectorOfVariables
-
-function vector_type(::Type{MOI.ScalarAffineFunction{T}}) where {T}
-    return MOI.VectorAffineFunction{T}
-end
-
-function vector_type(::Type{MOI.ScalarQuadraticFunction{T}}) where {T}
-    return MOI.VectorQuadraticFunction{T}
-end
+"""
+    promote_operation(
+        op::Function,
+        ::Type{T},
+        ArgsTypes::Type{<:Union{T,AbstractVector{T},MOI.AbstractFunction}}...,
+    ) where {T}
+
+Compute the return type of the call `operate(op, T, args...)`, where the types
+of the arguments `args` are `ArgsTypes`.
+
+There are five methods for which we implement `Utilities.promote_operation`:
+
+ 1. `+`
+    a. `promote_operation(::typeof(+), ::Type{T}, ::Type{F1}, ::Type{F2})`
+ 2. `-`
+    a. `promote_operation(::typeof(-), ::Type{T}, ::Type{F})`
+    b. `promote_operation(::typeof(-), ::Type{T}, ::Type{F1}, ::Type{F2})`
+    c. `promote_operation(::typeof(-), ::Type{T}, ::Type{F1}, ::Type{Vector{T}})`
+ 3. `*`
+    a. `promote_operation(::typeof(*), ::Type{T}, ::Type{T}, ::Type{F})`
+    b. `promote_operation(::typeof(*), ::Type{T}, ::Type{F1}, ::Type{F2})`
+       where `F1` and `F2` are `VariableIndex` or `ScalarAffineFunction`
+    c. `promote_operation(::typeof(*), ::Type{T}, ::Type{<:Diagonal{T}}, ::Type{F}`
+ 4. `/`
+    a. `promote_operation(::typeof(/), ::Type{T}, ::Type{F}, ::Type{T})`
+ 5. `vcat`
+    a. `promote_operation(::typeof(vcat), ::Type{T}, ::Type{F}...)`
+ 6. `imag`
+    a. `promote_operation(::typeof(imag), ::Type{T}, ::Type{F}`
+       where `F` is `VariableIndex` or `VectorOfVariables`
+
+There are nine types:
+
+ 1. ::T
+ 2. ::VariableIndex
+ 3. ::ScalarAffineFunction{T}
+ 4. ::ScalarQuadraticFunction{T}
+ 5. ::ScalarNonlinearFunction
+ 6. ::AbstractVector{T}
+ 7. ::VectorOfVariables
+ 8. ::VectorAffineFunction{T}
+ 9. ::VectorQuadraticFunction{T}
+"""
+function promote_operation end
 
 ### Method 1a and 2b