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
"""
screen(
model::MetabolicModel;
variants::Array{Vector}, N},
analysis::Function,
args::Array{Vector{Tuple}, N},
variants::Array{V,N}, # defaults to an array of identities
analysis,
args::Array{A,N}, # defaults to an array of empty argument lists
workers = [myid()],
)::Array where {N}
)::Array where {V<:AbstractVector,A,N}
Take an array of model-modifying function vectors in `variants`, and execute
the function `analysis` on all variants of the `model` specified by `variants`.
......@@ -113,11 +113,11 @@ screen(args...; kwargs...) =
"""
_screen_impl(
model::MetabolicModel;
variants::Array{Vector, N},
analysis::Function,
args::Array{Tuple, N},
variants::Array{V,N},
analysis,
args::Array{A,N},
workers = [myid()],
)::Array where {N}
)::Array where {V<:AbstractVector,A,N}
The actual implementation of [`screen`](@ref).
"""
......@@ -215,12 +215,12 @@ end
screen_optmodel_modifications(
model::MetabolicModel,
optimizer;
common_modifications::Vector = [],
modifications::Array{Vector,N},
args::Array{Vector{Tuple},N},
common_modifications::VF = [],
modifications::Array{V,N}, # defaults to an array with no modifications
args::Array{A,N}, # defaults to an array of empty argument lists
analysis::Function,
workers = [myid()],
) where N
)::Array where {V<:AbstractVector,VF<:AbstractVector,A,N}
Screen multiple modifications of the same optimization model.
......@@ -257,12 +257,12 @@ screen_optmodel_modifications(args...; kwargs...) = _screen_optmodel_modificatio
_screen_optmodel_modifications_impl(
model::MetabolicModel,
optimizer;
common_modifications::Vector = [],
modifications::Array{Vector,N},
args::Array{Tuple,N},
common_modifications::VF = [],
modifications::Array{V,N},
args::Array{A,N},
analysis::Function,
workers = [myid()],
) where N
)::Array where {V<:AbstractVector,VF<:AbstractVector,A,N}
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