Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update setvar! and setconstr! docstrings #497

Merged
merged 3 commits into from
Apr 7, 2021
Merged

Conversation

laradicp
Copy link
Contributor

@laradicp laradicp commented Apr 5, 2021

No description provided.

@laradicp laradicp requested a review from guimarqu April 5, 2021 16:26
@codecov
Copy link

codecov bot commented Apr 5, 2021

Codecov Report

Merging #497 (9d1eba7) into master (549ab01) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #497   +/-   ##
=======================================
  Coverage   83.83%   83.83%           
=======================================
  Files          47       47           
  Lines        4696     4696           
=======================================
  Hits         3937     3937           
  Misses        759      759           
Impacted Files Coverage Δ
src/MathProg/formulation.jl 74.02% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 549ab01...9d1eba7. Read the comment docs.

@@ -128,7 +128,7 @@ set_matrix_coeff!(
is_active::Bool = true,
is_explicit::Bool = true,
moi_index::MoiVarIndex = MoiVarIndex(),
members = nothing,
members::Union{ConstrMembership, Nothing} = nothing,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's misleading because ConstrMembership is an alias for Dict{Constrid, Float64}. I think it's better to remove all the types and describe each argument in a list.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. Same for setconstr!?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good idea

@laradicp laradicp changed the title Update setvar! docstring Update setvar! and setconstr! docstrings Apr 6, 2021
src/MathProg/formulation.jl Outdated Show resolved Hide resolved
src/MathProg/formulation.jl Outdated Show resolved Hide resolved
src/MathProg/formulation.jl Outdated Show resolved Hide resolved
src/MathProg/formulation.jl Outdated Show resolved Hide resolved
src/MathProg/formulation.jl Outdated Show resolved Hide resolved
src/MathProg/formulation.jl Outdated Show resolved Hide resolved
src/MathProg/formulation.jl Outdated Show resolved Hide resolved
src/MathProg/formulation.jl Outdated Show resolved Hide resolved
src/MathProg/formulation.jl Outdated Show resolved Hide resolved
src/MathProg/formulation.jl Outdated Show resolved Hide resolved
Co-authored-by: Guillaume Marques <[email protected]>
@guimarqu guimarqu merged commit 10157d5 into master Apr 7, 2021
@guimarqu guimarqu deleted the update_setvar_docstring branch April 7, 2021 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants