Merge pull request #51 from control-toolbox/return

return

Author: ocots

src/description.jl

@@ -37,7 +37,7 @@ makeDescription(desc::DescVarArg)::Description = Tuple(desc) # create a descript
 """
 $(TYPEDSIGNATURES)
 
-Returns the description.
+Return the description.
 
 # Example
 ```jldoctest
@@ -50,7 +50,7 @@ makeDescription(desc::Description)::Description = desc
 """
 $(TYPEDSIGNATURES)
 
-Returns a tuple containing only the description `y`.
+Return a tuple containing only the description `y`.
 
 # Example
 ```jldoctest
@@ -84,7 +84,7 @@ end
 """
 $(TYPEDSIGNATURES)
 
-Returns a complete description from an incomplete description `desc` and 
+Return a complete description from an incomplete description `desc` and 
 a list of complete descriptions `desc_list`. If several complete descriptions are possible, 
 then the first one is returned.
 
@@ -113,7 +113,7 @@ end
 """
 $(TYPEDSIGNATURES)
 
-Returns the difference between the description `x` and the description `y`.
+Return the difference between the description `x` and the description `y`.
 
 # Example
 ```jldoctest

src/model.jl

@@ -53,49 +53,49 @@ Base.isless(i::Index, j::Index) = i.val ≤ j.val
 """
 $(TYPEDSIGNATURES)
 
-Returns :nonautonomous == time_dependence
+Return :nonautonomous == time_dependence
 """
 isnonautonomous(time_dependence::Symbol) = :nonautonomous == time_dependence
 
 """
 $(TYPEDSIGNATURES)
 
-Returns !isnonautonomous(time_dependence)
+Return !isnonautonomous(time_dependence)
 """
 isautonomous(time_dependence::Symbol) = !isnonautonomous(time_dependence)
 
 """
 $(TYPEDSIGNATURES)
 
-Returns `true` if the model has been defined as nonautonomous.
+Return `true` if the model has been defined as nonautonomous.
 """
 isnonautonomous(ocp::OptimalControlModel{time_dependence}) where {time_dependence} = isnonautonomous(time_dependence)
 
 """
 $(TYPEDSIGNATURES)
 
-Returns `true` if the model has been defined as autonomous.
+Return `true` if the model has been defined as autonomous.
 """
 isautonomous(ocp::OptimalControlModel) = !isnonautonomous(ocp)
 
 """
 $(TYPEDSIGNATURES)
 
-Returns `true` if the criterion type of `ocp` is `:min`.
+Return `true` if the criterion type of `ocp` is `:min`.
 """
 ismin(ocp::OptimalControlModel) = ocp.criterion == :min
 
 """
 $(TYPEDSIGNATURES)
 
-Returns `true` if the criterion type of `ocp` is `:max`.
+Return `true` if the criterion type of `ocp` is `:max`.
 """
 ismax(ocp::OptimalControlModel) = !ismin(ocp)
 
 """
 $(TYPEDSIGNATURES)
 
-Returns a new `OptimalControlModel` instance, that is a model of an optimal control problem.
+Return a new `OptimalControlModel` instance, that is a model of an optimal control problem.
 
 The model is defined by the following optional keyword argument:
 
@@ -659,7 +659,7 @@ end
 """
 $(TYPEDSIGNATURES)
 
-Returns the labels of the constraints as a `Base.keys`.
+Return the labels of the constraints as a `Base.keys`.
 
 # Example
 

src/plot.jl

@@ -195,7 +195,7 @@ end
 """
 $(TYPEDSIGNATURES)
 
-Returns `x` and `y` for the plot of the optimal control solution `sol` 
+Return `x` and `y` for the plot of the optimal control solution `sol` 
 corresponding respectively to the argument `xx` and the argument `yy`.
 
 **Notes.**

src/utils.jl

@@ -1,7 +1,7 @@
 """
 $(TYPEDSIGNATURES)
 
-Returns `i` ∈ [0, 9] as a subscript.
+Return `i` ∈ [0, 9] as a subscript.
 """
 function ctindice(i::Integer)::Char
     if i < 0 || i > 9
@@ -13,7 +13,7 @@ end
 """
 $(TYPEDSIGNATURES)
 
-Returns `i` > 0 as a subscript.
+Return `i` > 0 as a subscript.
 """
 function ctindices(i::Integer)::String
     if i < 0
@@ -29,7 +29,7 @@ end
 """
 $(TYPEDSIGNATURES)
 
-Returns `i` ∈ [0, 9] as an upperscript.
+Return `i` ∈ [0, 9] as an upperscript.
 """
 function ctupperscript(i::Integer)::Char
     if i < 0 || i > 9
@@ -55,7 +55,7 @@ end
 """
 $(TYPEDSIGNATURES)
 
-Returns `i` > 0 as an upperscript.
+Return `i` > 0 as an upperscript.
 """
 function ctupperscripts(i::Integer)::String
     if i < 0
@@ -71,21 +71,21 @@ end
 """
 $(TYPEDSIGNATURES)
 
-Returns the gradient of `f` at `x`.
+Return the gradient of `f` at `x`.
 """
 ctgradient(f::Function, x) = ForwardDiff.gradient(f, x)
 
 """
 $(TYPEDSIGNATURES)
 
-Returns the Jacobian of `f` at `x`.
+Return the Jacobian of `f` at `x`.
 """
 ctjacobian(f::Function, x) = ForwardDiff.jacobian(f, x)
 
 """
 $(TYPEDSIGNATURES)
 
-Returns the interpolation of `f` at `x`.
+Return the interpolation of `f` at `x`.
 """
 function ctinterpolate(x, f) # default for interpolation of the initialization
     return Interpolations.linear_interpolation(x, f, extrapolation_bc=Interpolations.Line())
@@ -127,14 +127,14 @@ expand(x::Vector{<:Vector{<:ctNumber}}) = vec2vec(x)
 """
 $(TYPEDSIGNATURES)
 
-Returns `x`.
+Return `x`.
 """
 expand(x::Vector{<:ctNumber}) = x
 
 """
 $(TYPEDSIGNATURES)
 
-Returns `expand(matrix2vec(x, 1))`
+Return `expand(matrix2vec(x, 1))`
 """
 expand(x::Matrix{<:ctNumber}) = expand(matrix2vec(x, 1))
 
@@ -175,7 +175,7 @@ end
 """
 $(TYPEDSIGNATURES)
 
-Returns the Poisson bracket of `f` and `g`.
+Return the Poisson bracket of `f` and `g`.
 """
 function Poisson(f, g)
     function fg(x, p)