Merge pull request #409 from LCSB-BioCore/mk-doc-optimize-objective

document `optimize_objective`

src/base/solver.jl

@@ -58,6 +58,12 @@ function is_solved(optmodel)
     termination_status(optmodel) in [MOI.OPTIMAL, MOI.LOCALLY_SOLVED] ? true : false
 end
 
+"""
+    optimize_objective(optmodel)::Union{Float64,Nothing}
+
+Shortcut for running JuMP `optimize!` on a model and returning the objective
+value, if solved.
+"""
 function optimize_objective(optmodel)::Union{Float64,Nothing}
     optimize!(optmodel)
     if is_solved(optmodel)