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 documentation #461

Merged
merged 27 commits into from
Jan 29, 2019
Merged

Update documentation #461

merged 27 commits into from
Jan 29, 2019

Conversation

yeesian
Copy link
Contributor

@yeesian yeesian commented Jan 29, 2019

As promised in #169

@codecov
Copy link

codecov bot commented Jan 29, 2019

Codecov Report

Merging #461 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #461   +/-   ##
=======================================
  Coverage   94.26%   94.26%           
=======================================
  Files          35       35           
  Lines        5007     5007           
=======================================
  Hits         4720     4720           
  Misses        287      287
Impacted Files Coverage Δ
src/prob/test.jl 94.76% <ø> (ø) ⬆️
src/core/base.jl 98.55% <ø> (ø) ⬆️
src/core/constraint.jl 89.23% <ø> (ø) ⬆️
src/util/obbt.jl 93.69% <ø> (ø) ⬆️
src/core/constraint_template.jl 93.87% <100%> (ø) ⬆️

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 3b58c5a...176ff2e. Read the comment docs.

1 similar comment
@codecov
Copy link

codecov bot commented Jan 29, 2019

Codecov Report

Merging #461 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #461   +/-   ##
=======================================
  Coverage   94.26%   94.26%           
=======================================
  Files          35       35           
  Lines        5007     5007           
=======================================
  Hits         4720     4720           
  Misses        287      287
Impacted Files Coverage Δ
src/prob/test.jl 94.76% <ø> (ø) ⬆️
src/core/base.jl 98.55% <ø> (ø) ⬆️
src/core/constraint.jl 89.23% <ø> (ø) ⬆️
src/util/obbt.jl 93.69% <ø> (ø) ⬆️
src/core/constraint_template.jl 93.87% <100%> (ø) ⬆️

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 3b58c5a...176ff2e. Read the comment docs.

@ccoffrin
Copy link
Member

LGTM, any objections @kaarthiksundar, @pseudocubic?

@kaarthiksundar
Copy link
Collaborator

This looks great. Thanks @yeesian. I have no issues with the PR

"minor":<int>,
"patch":<int>,
...
},
Copy link
Collaborator

Choose a reason for hiding this comment

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

This doesn't seem necessary, since we can just use a single string to represent a version. Is this to support some change I'm not aware of having been discussed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was going by the output from

using PowerModels
network_data = PowerModels.parse_file("matpower/case3.m")
JSON.json(network_data)

Julia's version strings gets turned into such dictionaries in JSON.jl

If a string is preferred, then that line should be modified accordingly.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah, I wasn't aware that it did this. I will make a new Issue to fix it, and will revert the documentation when it gets fixed.

Copy link
Collaborator

@pseudocubic pseudocubic left a comment

Choose a reason for hiding this comment

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

I made one comment on a change in docs/src/network-data.md, but otherwise it looks really good to me as well, thanks for the contribution!

@pseudocubic pseudocubic merged commit a98169d into lanl-ansi:master Jan 29, 2019
@yeesian yeesian mentioned this pull request Feb 21, 2019
3 tasks
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.

4 participants