Commit 5f5aad54 authored by Miroslav Kratochvil's avatar Miroslav Kratochvil
Browse files

fix the types in the docstrings

parent 6a44d40c
Pipeline #48354 passed with stages
in 8 minutes and 6 seconds
...@@ -35,11 +35,11 @@ end ...@@ -35,11 +35,11 @@ end
""" """
screen( screen(
model::MetabolicModel; model::MetabolicModel;
variants::Array{Vector}, N}, variants::Array{V,N}, # defaults to an array of identities
analysis::Function, analysis,
args::Array{Vector{Tuple}, N}, args::Array{A,N}, # defaults to an array of empty argument lists
workers = [myid()], workers = [myid()],
)::Array where {N} )::Array where {V<:AbstractVector,A,N}
Take an array of model-modifying function vectors in `variants`, and execute Take an array of model-modifying function vectors in `variants`, and execute
the function `analysis` on all variants of the `model` specified by `variants`. the function `analysis` on all variants of the `model` specified by `variants`.
...@@ -113,11 +113,11 @@ screen(args...; kwargs...) = ...@@ -113,11 +113,11 @@ screen(args...; kwargs...) =
""" """
_screen_impl( _screen_impl(
model::MetabolicModel; model::MetabolicModel;
variants::Array{Vector, N}, variants::Array{V,N},
analysis::Function, analysis,
args::Array{Tuple, N}, args::Array{A,N},
workers = [myid()], workers = [myid()],
)::Array where {N} )::Array where {V<:AbstractVector,A,N}
The actual implementation of [`screen`](@ref). The actual implementation of [`screen`](@ref).
""" """
...@@ -215,12 +215,12 @@ end ...@@ -215,12 +215,12 @@ end
screen_optmodel_modifications( screen_optmodel_modifications(
model::MetabolicModel, model::MetabolicModel,
optimizer; optimizer;
common_modifications::Vector = [], common_modifications::VF = [],
modifications::Array{Vector,N}, modifications::Array{V,N}, # defaults to an array with no modifications
args::Array{Vector{Tuple},N}, args::Array{A,N}, # defaults to an array of empty argument lists
analysis::Function, analysis::Function,
workers = [myid()], workers = [myid()],
) where N )::Array where {V<:AbstractVector,VF<:AbstractVector,A,N}
Screen multiple modifications of the same optimization model. Screen multiple modifications of the same optimization model.
...@@ -257,12 +257,12 @@ screen_optmodel_modifications(args...; kwargs...) = _screen_optmodel_modificatio ...@@ -257,12 +257,12 @@ screen_optmodel_modifications(args...; kwargs...) = _screen_optmodel_modificatio
_screen_optmodel_modifications_impl( _screen_optmodel_modifications_impl(
model::MetabolicModel, model::MetabolicModel,
optimizer; optimizer;
common_modifications::Vector = [], common_modifications::VF = [],
modifications::Array{Vector,N}, modifications::Array{V,N},
args::Array{Tuple,N}, args::Array{A,N},
analysis::Function, analysis::Function,
workers = [myid()], workers = [myid()],
) where N )::Array where {V<:AbstractVector,VF<:AbstractVector,A,N}
The actual implementation of [`screen_optmodel_modifications`](@ref). The actual implementation of [`screen_optmodel_modifications`](@ref).
""" """
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment