GAMS-dev / gams.jl

A MathOptInterface Optimizer to solve JuMP models using GAMS
MIT License
35 stars 3 forks source link

Update README.md for JuMP documentation #22

Closed odow closed 1 year ago

odow commented 1 year ago

I'm planning to add GAMS.jl README to the JuMP documentation: https://github.com/jump-dev/JuMP.jl/pull/3357

This is how it currently looks: https://jump.dev/JuMP.jl/previews/PR3357/packages/GAMS/.

As part of that, we run a linter to detect typos etc. Here are a couple of problems it found: https://github.com/jump-dev/JuMP.jl/actions/runs/4999444928/jobs/8955840737?pr=3357#step:7:22

renkekuhlmann commented 1 year ago

Hi, looks great! Thanks for your efforts! Sorry for responding so late, I am currently in parental leave and don't check my mails too often. The only real issue I see is "exlicitly". Do I simply have to update our README and that's it? Or is there something else to consider?

odow commented 1 year ago

The only real issue I see is "exlicitly"

There are a few issues.

Documenter uses indentation to infer lists

image

The linter doesn't like exlicitly or e.g.

image

Do I simply have to update our README and that's it?

Yes. If you update the README, then the JuMP docs will pull it in.

See https://github.com/jump-dev/JuMP.jl/blob/master/docs/packages.toml

You can see a bunch of other solvers here: https://jump.dev/JuMP.jl/previews/PR3357/packages/NEOSServer/

odow commented 1 year ago

I am currently in parental leave and don't check my mails too often

Congratulations! This isn't urgent.

renkekuhlmann commented 1 year ago

@odow Sorry, last time I checked my mails and wrote the comment above I didn't realize that you prepared this nice pull request and just looked at the links provided in your first comment. I fixed the README and also updated the list of solvers in it (which was a bit outdated). Thanks a lot for your work!