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

[docs] remove solver-specific notes #2578

Merged
merged 3 commits into from
Apr 29, 2021
Merged

[docs] remove solver-specific notes #2578

merged 3 commits into from
Apr 29, 2021

Conversation

odow
Copy link
Member

@odow odow commented Apr 29, 2021

I removed the "solver-specific notes" section because the list of solvers is growing, and this section is getting long and could get out-dated. in addition, we discuss some solvers in detail, so why not all? Details (like the paragraph on ProxSDP, to pick one example) are best left to the solver's README.

One option I have been considering is to figure out a way to include each solver's README as a page in the JuMP documentation. Then we could standardize that format to give users a consistent documentation for each solver in an accessible place.

@codecov
Copy link

codecov bot commented Apr 29, 2021

Codecov Report

Merging #2578 (890cfcb) into master (9d4a379) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2578   +/-   ##
=======================================
  Coverage   93.37%   93.37%           
=======================================
  Files          44       44           
  Lines        5511     5511           
=======================================
  Hits         5146     5146           
  Misses        365      365           

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 9d4a379...890cfcb. Read the comment docs.

@mlubin
Copy link
Member

mlubin commented Apr 29, 2021

We should check that the information we're deleting is present in the solver READMEs.

@odow odow mentioned this pull request Apr 29, 2021
```julia
using MosekTools
model = Model(Mosek.Optimizer)
```
Copy link
Member Author

Choose a reason for hiding this comment

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

@odow odow merged commit 0aa6ad1 into master Apr 29, 2021
@odow odow deleted the odow-patch-1 branch April 29, 2021 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants