I think one of the more common issues we encounter is that some examples don't work out of the box. We may have introduced a lot of changes in the API from the previous versions and weren't able to update the docs properly.

Let's scope this one out, right now we have docs located in:

• Our docstrings
• Jupyter notebooks

I know we did this exercise before, but it may be good to revisit it

Hey guys, for the ub and lb you declare it as a function. But when you pass it later to unit box you declare it in unit box function docu as a np.array. I think the func should just be replaced by np.array

:type lb: function
:param ub: Upper variable bounds, of size 1 x dim
:type ub: function

Cheers :)

Proposed Sections on POD Documentation,

• README.md: general description and instructions for POD.jl

• Documenter.jl

  • Introduction: General solver description
  • How to Use: Instruction of installing and using POD with an example
  • Choosing Solver: List of supported sub-solvers and directions on how to use them
  • Algorithm: Big-picture description and point to the paper
  • Expr

Fix the typos in the documentation found here and improve the readability as well as detailing the use of the arguments inside the algorithm #27.

The examples should also include usage of advanced features such as the symmetry argument of the algorithm to increase visibility.