Updated docs for phases and dynamic variables

Author: e-duar-do

docs/src/reference/dynamic_functions/dynamic_variables.md

@@ -6,23 +6,27 @@ CurrentModule = DynOptInterface
 
 ```@docs
 DynamicVariableIndex
-supports_dynamic_variable
-UnsupportedDynamicVariable
-AddDynamicVariableNotAllowed
+```
+
+# Dynamic Variables in Models
+
+```@docs
+supports_dynamic_variables
+UnsupportedDynamicVariablesError
 add_dynamic_variable
+AddDynamicVariableNotAllowedError
 MOI.is_valid(::MOI.ModelLike, ::DynamicVariableIndex)
-InvalidDynamicVariableIndex
+InvalidDynamicVariableError
 ```
 
-# Attributes
-
-The [`DynamicVariableIndex`](@ref) object is compatible with the following attributes:
-* [`MOI.VariableName`](@extref MathOptInterface.VariableName) with value types `String`
-* [`MOI.VariablePrimal`](@extref MathOptInterface.VariablePrimal) with value types [`AbstractDynamicSolution`](@ref)
-* [`MOI.VariablePrimalStart`](@extref MathOptInterface.VariablePrimalStart) with value types [`AbstractDynamicSolution`](@ref)
+# Dynamic Variable Attributes
 
 ```@docs
-MOI.supports(::MOI.ModelLike, ::MOI.AbstractVariableAttribute, ::Type{DynamicVariableIndex})
-MOI.set(::MOI.ModelLike, ::MOI.AbstractVariableAttribute, ::DynamicVariableIndex, ::Any)
-MOI.get(::MOI.ModelLike, ::MOI.AbstractVariableAttribute, ::DynamicVariableIndex)
+AbstractDynamicVariableAttribute
+MOI.supports(::MOI.ModelLike, ::AbstractDynamicVariableAttribute)
+MOI.set(::MOI.ModelLike, ::AbstractDynamicVariableAttribute, ::DynamicVariableIndex, ::Any)
+MOI.get(::MOI.ModelLike, ::AbstractDynamicVariableAttribute, ::DynamicVariableIndex)
+DynamicVariableName
+DynamicVariableInitialStart
+DynamicVariableFinalStart
 ```

docs/src/reference/dynamic_functions/phases.md

@@ -30,4 +30,6 @@ MOI.supports(::MOI.ModelLike, ::AbstractPhaseAttribute)
 MOI.set(::MOI.ModelLike, ::AbstractPhaseAttribute, ::PhaseIndex, ::Any)
 MOI.get(::MOI.ModelLike, ::AbstractPhaseAttribute, ::PhaseIndex)
 PhaseName
+PhaseInitialStart
+PhaseFinalStart
 ```

src/dynamic_functions/dynamic_variables.jl

@@ -1,7 +1,7 @@
 """
     DynamicVariableIndex(value::Int64, phase::PhaseIndex)
 
-Represent the dynamic variable ``\boldsymbol{y}_j(\cdot)`` in an expression.
+Represent the dynamic variable ``\\boldsymbol{y}_j(\\cdot)`` in an expression.
 
 It is a subtype of [`AbstractDynamicFunction`](@ref).
 To allow for deletion, indices need not be consecutive.
@@ -88,19 +88,19 @@ abstract type AbstractDynamicVariableAttribute end
 """
     MOI.supports(
         model::MOI.ModelLike,
-        attr::MOI.AbstractDynamicVariableAttribute,
+        attr::AbstractDynamicVariableAttribute,
     )::Bool
 
 Indicate whether `model` supports the dynamic variable attribute `attr`.
 """
-function MOI.supports(::MOI.ModelLike, ::MOI.AbstractDynamicVariableAttribute)
+function MOI.supports(::MOI.ModelLike, ::AbstractDynamicVariableAttribute)
     return false
 end
 
 """
     MOI.set(
         model::MOI.ModelLike,
-        attr::MOI.AbstractDynamicVariableAttribute,
+        attr::AbstractDynamicVariableAttribute,
         dyn_var::DynamicVariableIndex,
         value::Any,
     )
@@ -109,7 +109,7 @@ Assign `value` to the attribute `attr` of dynamic variable `dyn_var` in model `m
 """
 function MOI.set(
     model::MOI.ModelLike,
-    attr::MOI.AbstractDynamicVariableAttribute,
+    attr::AbstractDynamicVariableAttribute,
     ::DynamicVariableIndex,
     value::Any,
 )
@@ -128,7 +128,7 @@ end
 """
     MOI.get(
         model::MOI.ModelLike,
-        attr::MOI.AbstractDynamicVariableAttribute,
+        attr::AbstractDynamicVariableAttribute,
         dyn_var::DynamicVariableIndex,
     )
 
@@ -139,7 +139,7 @@ If the attribute is supported but has not been set, `nothing` is returned.
 """
 function MOI.get(
     model::MOI.ModelLike,
-    attr::MOI.AbstractDynamicVariableAttribute,
+    attr::AbstractDynamicVariableAttribute,
     dyn_var::DynamicVariableIndex,
 )
     throw(ArgumentError(
@@ -161,7 +161,7 @@ struct DynamicVariableName <: AbstractDynamicVariableAttribute end
 A dynamic variable attribute for the start value of the dynamic variable at the initial
 phase boundary.
 """
-struct DynamicVariableInitialPrimalStart <: AbstractDynamicVariableAttribute end
+struct DynamicVariableInitialStart <: AbstractDynamicVariableAttribute end
 
 """
     DynamicVariableFinalStart