# Please suggest improvements to the JuMP documentation

**URL:** https://discourse.julialang.org/t/please-suggest-improvements-to-the-jump-documentation/55596
**Category:** Optimization (Mathematical)
**Created:** [February 19, 2021, 2:24am UTC](https://discourse.julialang.org/t/please-suggest-improvements-to-the-jump-documentation/55596 "2021-02-19T02:24:02Z")
**Posts on this page:** 6
**Page:** 1

<div class="post-metadata">

### Author: ![odow](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/odow/32/28685_2.png) [@odow](https://discourse.julialang.org/u/odow)
#### Post date: [February 19, 2021, 2:24am UTC](https://discourse.julialang.org/t/please-suggest-improvements-to-the-jump-documentation/55596/1 "2021-02-19T02:24:02Z")

</div>

Dear all,

I have been busy making improvements to the JuMP documentation that will be available in the next release. (You can find the development version here: [Introduction · JuMP](https://jump.dev/JuMP.jl/dev)) Highlights of the changes include [integrated tutorials](https://jump.dev/JuMP.jl/dev/tutorials/Getting%20started/an_introduction_to_julia/), and revised pages on [models](https://jump.dev/JuMP.jl/dev/manual/models/), [nonlinear modeling](https://jump.dev/JuMP.jl/dev/manual/nlp/), [containers](https://jump.dev/JuMP.jl/dev/manual/containers/), and [objectives](https://jump.dev/JuMP.jl/dev/manual/objective/).

I’m interested in hearing any feedback or suggestions people have concerning:

- parts of the JuMP documentation you found (or find) confusing
- topics you wished were covered in the JuMP documentation (because you had to find them elsewhere)
- spelling mistakes, formatting errors, etc.

I’m especially interested to hear from anyone who started using JuMP recently, because if you’re confused about parts of the documentation, we should fix that!

Please reply to this thread, or send me a private message if you prefer.

Oscar

---

<div class="post-metadata">

### Author: ![odow](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/odow/32/28685_2.png) [@odow](https://discourse.julialang.org/u/odow)
#### Post date: [February 19, 2021, 2:24am UTC](https://discourse.julialang.org/t/please-suggest-improvements-to-the-jump-documentation/55596/2 "2021-02-19T02:24:31Z")

</div>



---

<div class="post-metadata">

### Author: ![baggepinnen](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/baggepinnen/32/693_2.png) [@baggepinnen](https://discourse.julialang.org/u/baggepinnen)
#### Post date: [February 19, 2021, 1:45pm UTC](https://discourse.julialang.org/t/please-suggest-improvements-to-the-jump-documentation/55596/3 "2021-02-19T13:45:37Z")

</div>

Something I’m usually struggling with when using (later versions of) JuMP is that there is on longer an automatic understanding of `norm(x)`, instead I get a message saying that I have to manually rewrite the constraint or objective using the `SecondOrderCone`. It would be good to have one (or many) clear examples on how to do this, I usually have to try and fail for a while, or dig up the code from the last time I did it.

(Even better would of course be if JuMP could just let me write my model using `norm`)

---

<div class="post-metadata">

### Author: ![odow](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/odow/32/28685_2.png) [@odow](https://discourse.julialang.org/u/odow)
#### Post date: [February 19, 2021, 7:50pm UTC](https://discourse.julialang.org/t/please-suggest-improvements-to-the-jump-documentation/55596/4 "2021-02-19T19:50:46Z")

</div>

Thanks. I’ve opened an issue to track these: [Documentation suggestions from Discourse · Issue #2487 · jump-dev/JuMP.jl · GitHub](https://github.com/jump-dev/JuMP.jl/issues/2487). I’m not sure if we can make JuMP work with `norm`, but we can write examples of how to do this, and improve the error message to include some examples.

---

<div class="post-metadata">

### Author: ![mike\_k](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mike_k/32/211864_2.png) [@mike\_k](https://discourse.julialang.org/u/mike_k)
#### Post date: [March 9, 2021, 5:28pm UTC](https://discourse.julialang.org/t/please-suggest-improvements-to-the-jump-documentation/55596/5 "2021-03-09T17:28:06Z")

</div>

A “performance tips” section would be great. At least I remember an [old post](https://discourse.julialang.org/t/jump-cplex-adding-objective-function-expression-in-loop-is-very-resource-consuming/21859) of my beginner mistakes which possibly could have been avoided with such a section. Also an old [question](https://discourse.julialang.org/t/jump-0-18-summing-up-elements-of-solution-vector-allocates-memory/24488) regarding type annotations occupied me a while.

---

<div class="post-metadata">

### Author: ![odow](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/odow/32/28685_2.png) [@odow](https://discourse.julialang.org/u/odow)
#### Post date: [March 9, 2021, 8:26pm UTC](https://discourse.julialang.org/t/please-suggest-improvements-to-the-jump-documentation/55596/6 "2021-03-09T20:26:37Z")

</div>

Thanks! Linking to these old questions is very helpful.
