jump-dev / JuMP.jl

Modeling language for Mathematical Optimization (linear, mixed-integer, conic, semidefinite, nonlinear)
http://jump.dev/JuMP.jl/
Other
2.17k stars 390 forks source link

[docs] improve various docstrings #3758

Closed odow closed 1 month ago

odow commented 1 month ago

Motivated by https://discourse.julialang.org/t/cpu-time-vs-wallclock/114776

https://jump.dev/JuMP.jl/previews/PR3758/api/JuMP/#solve_time

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.38%. Comparing base (fad385c) to head (15a74cc).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3758 +/- ## ======================================= Coverage 98.38% 98.38% ======================================= Files 44 44 Lines 5869 5871 +2 ======================================= + Hits 5774 5776 +2 Misses 95 95 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

odow commented 1 month ago

There are still a bunch that can be improved, but this is a good start.

odow commented 1 month ago

The original motivation goes from

image

to

image