contribute

jgillis edited this page Feb 3, 2015 · 1 revision

This page gives a quick overview of easy ways to help the CasADi project go forward.

Documentation

Was a particular function such as e.g. vertsplit not obvious to use?

Why not add a little bit of documentation to help other users and your future self?

Just locate it in our sources and look for a Doxygen comment:

/** \brief Concatenate a list of matrices vertically
* Alternative terminology: vertical stack, vstack, vertical append, [a;b]
*
* vertcat(vertsplit(x, ...)) = x
*/
inline friend MatType vertcat(const std::vector<MatType> &v);

You can edit that file in your browser. Just add some extra explanation at will.

As a bonus, you can also add python code snippets into that docstrings. See in-documentation-snippets for details.