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

RFC: Solution query docs #1731

Merged
merged 15 commits into from Jan 11, 2019
Merged

RFC: Solution query docs #1731

merged 15 commits into from Jan 11, 2019

Conversation

joaquimg
Copy link
Member

@joaquimg joaquimg commented Jan 4, 2019

Sketch the solution query part of the manual

  • Should we add tables to enums of point to the docstrings of the enum?

Targets: #1621

@codecov
Copy link

codecov bot commented Jan 4, 2019

Codecov Report

Merging #1731 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1731   +/-   ##
=======================================
  Coverage   68.69%   68.69%           
=======================================
  Files          30       30           
  Lines        3891     3891           
=======================================
  Hits         2673     2673           
  Misses       1218     1218

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 a9d7e28...d59bb38. Read the comment docs.

@codecov
Copy link

codecov bot commented Jan 4, 2019

Codecov Report

Merging #1731 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1731   +/-   ##
=======================================
  Coverage   68.92%   68.92%           
=======================================
  Files          30       30           
  Lines        3923     3923           
=======================================
  Hits         2704     2704           
  Misses       1219     1219
Impacted Files Coverage Δ
src/constraints.jl 72.94% <ø> (ø) ⬆️

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 cca15bb...a710611. Read the comment docs.

docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved

```@docs
JuMP.termination_status
MOI.TerminationStatus
Copy link
Member

Choose a reason for hiding this comment

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

Does this display correctly? I didn't know you could display docstrings like this for other symbols in other packages.

Copy link
Member Author

Choose a reason for hiding this comment

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

I haven't tested.

Copy link
Member

Choose a reason for hiding this comment

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

Please build the docs locally to double check that they display as intended.

Copy link
Member Author

Choose a reason for hiding this comment

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

yup

Copy link
Member

Choose a reason for hiding this comment

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

image

docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Show resolved Hide resolved
@joaquimg
Copy link
Member Author

joaquimg commented Jan 6, 2019

@blegat, I understood that I cannot reference AbstractShape and dual_shape because they are no in the manual

@blegat
Copy link
Member

blegat commented Jan 7, 2019

The missing reference for shape is fixed but there are other issues remaining:
https://travis-ci.org/JuliaOpt/JuMP.jl/jobs/475843545#L639-L653

docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
@odow
Copy link
Member

odow commented Jan 9, 2019

I am addressing these comments now.

@odow odow changed the title WIP: Solutions query docs RFC: Solution query docs Jan 9, 2019
docs/src/solutions.md Outdated Show resolved Hide resolved
docs/src/solutions.md Outdated Show resolved Hide resolved
@blegat blegat merged commit ee45c79 into master Jan 11, 2019
@odow odow deleted the jg/querysol branch January 27, 2019 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants